Added @deprecated, java doc fixes. Relates to github #2026

dghgit · dghgit · commit 8046a43a40c8 · 2025-08-13T22:19:35.000+10:00
diff --git a/core/src/main/java/org/bouncycastle/asn1/BERBitStringParser.java b/core/src/main/java/org/bouncycastle/asn1/BERBitStringParser.java
@@ -10,6 +10,7 @@
  * 
  * @deprecated Check for 'ASN1BitStringParser' instead 
  */
+@Deprecated
 public class BERBitStringParser
     implements ASN1BitStringParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java b/core/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java
@@ -10,6 +10,7 @@
  * 
  * @deprecated Check for 'ASN1OctetStringParser' instead 
  */
+@Deprecated
 public class BEROctetStringParser
     implements ASN1OctetStringParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/BERSequenceParser.java b/core/src/main/java/org/bouncycastle/asn1/BERSequenceParser.java
@@ -7,6 +7,7 @@
  * 
  * @deprecated Check for 'ASN1SequenceParser' instead 
  */
+@Deprecated
 public class BERSequenceParser
     implements ASN1SequenceParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/BERSetParser.java b/core/src/main/java/org/bouncycastle/asn1/BERSetParser.java
@@ -7,6 +7,7 @@
  * 
  * @deprecated Check for 'ASN1SetParser' instead 
  */
+@Deprecated
 public class BERSetParser
     implements ASN1SetParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/DERExternal.java b/core/src/main/java/org/bouncycastle/asn1/DERExternal.java
@@ -20,6 +20,7 @@ public class DERExternal
      * 
      * @deprecated Use {@link DERExternal#DERExternal(DERSequence)} instead.
      */
+    @Deprecated
     public DERExternal(ASN1EncodableVector vector)
     {
         this(DERFactory.createSequence(vector));
diff --git a/core/src/main/java/org/bouncycastle/asn1/DEROctetStringParser.java b/core/src/main/java/org/bouncycastle/asn1/DEROctetStringParser.java
@@ -8,6 +8,7 @@
  * 
  * @deprecated Check for 'ASN1OctetStringParser' instead 
  */
+@Deprecated
 public class DEROctetStringParser
     implements ASN1OctetStringParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/DLBitStringParser.java b/core/src/main/java/org/bouncycastle/asn1/DLBitStringParser.java
@@ -8,6 +8,7 @@
  * 
  * @deprecated Check for 'ASN1BitStringParser' instead 
  */
+@Deprecated
 public class DLBitStringParser
     implements ASN1BitStringParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/DLExternal.java b/core/src/main/java/org/bouncycastle/asn1/DLExternal.java
@@ -20,6 +20,7 @@ public class DLExternal
      * 
      * @deprecated Use {@link DLExternal#DLExternal(DLSequence)} instead.
      */
+    @Deprecated
     public DLExternal(ASN1EncodableVector vector)
     {
         this(DLFactory.createSequence(vector));
diff --git a/core/src/main/java/org/bouncycastle/asn1/DLSequenceParser.java b/core/src/main/java/org/bouncycastle/asn1/DLSequenceParser.java
@@ -7,6 +7,7 @@
  * 
  * @deprecated Check for 'ASN1SequenceParser' instead 
  */
+@Deprecated
 public class DLSequenceParser
     implements ASN1SequenceParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/DLSetParser.java b/core/src/main/java/org/bouncycastle/asn1/DLSetParser.java
@@ -7,6 +7,7 @@
  * 
  * @deprecated Check for 'ASN1SetParser' instead 
  */
+@Deprecated
 public class DLSetParser
     implements ASN1SetParser
 {
diff --git a/core/src/main/java/org/bouncycastle/asn1/pkcs/PKCSObjectIdentifiers.java b/core/src/main/java/org/bouncycastle/asn1/pkcs/PKCSObjectIdentifiers.java
@@ -195,6 +195,7 @@ public interface PKCSObjectIdentifiers
 
     /** PKCS#9: 1.2.840.113549.1.9.22.1
      * @deprecated use x509Certificate instead */
+    @Deprecated
     ASN1ObjectIdentifier    x509certType            = pkcs_9.branch("22.1");
 
     /** PKCS#9: 1.2.840.113549.1.9.22 */
@@ -259,6 +260,7 @@ public interface PKCSObjectIdentifiers
     /** S/MIME: Algorithm Identifiers ; 1.2.840.113549.1.9.16.3 */
     ASN1ObjectIdentifier smime_alg = id_smime.branch("3");
     /** @deprecated use smime_alg instead */
+    @Deprecated
     ASN1ObjectIdentifier id_alg = id_smime.branch("3");
 
     /** PKCS#9: 1.2.840.113549.1.9.16.3.5 */
@@ -433,12 +435,16 @@ public interface PKCSObjectIdentifiers
     ASN1ObjectIdentifier id_aa_communityIdentifiers = id_aa.branch("40");
 
     /** @deprecated use id_aa_ets_sigPolicyId instead */
+    @Deprecated
     ASN1ObjectIdentifier id_aa_sigPolicyId    = id_aa_ets_sigPolicyId;
     /** @deprecated use id_aa_ets_commitmentType instead */
+    @Deprecated
     ASN1ObjectIdentifier id_aa_commitmentType = id_aa_ets_commitmentType;
     /** @deprecated use id_aa_ets_signerLocation instead */
+    @Deprecated
     ASN1ObjectIdentifier id_aa_signerLocation = id_aa_ets_signerLocation;
     /** @deprecated use id_aa_ets_otherSigCert instead */
+    @Deprecated
     ASN1ObjectIdentifier id_aa_otherSigCert   = id_aa_ets_otherSigCert;
     
     /**
@@ -447,6 +453,7 @@ public interface PKCSObjectIdentifiers
      * 1.2.840.113549.1.9.16.5
      * @deprecated use id_spq_oid instead
      */
+    @Deprecated
     final String id_spq = "1.2.840.113549.1.9.16.5";
     ASN1ObjectIdentifier id_spq_oid = id_smime.branch("5");
 
@@ -497,6 +504,7 @@ public interface PKCSObjectIdentifiers
      * PKCS#12: 1.2.840.113549.1.12.1.6
      * @deprecated use pbeWithSHAAnd40BitRC2_CBC
      */
+    @Deprecated
     ASN1ObjectIdentifier    pbewithSHAAnd40BitRC2_CBC = pkcs_12PbeIds.branch("6");
 }
 
diff --git a/core/src/main/java/org/bouncycastle/asn1/x509/SubjectPublicKeyInfo.java b/core/src/main/java/org/bouncycastle/asn1/x509/SubjectPublicKeyInfo.java
@@ -74,6 +74,7 @@ public SubjectPublicKeyInfo(
     /**
      @deprecated use SubjectPublicKeyInfo.getInstance()
      */
+    @Deprecated
     public SubjectPublicKeyInfo(
         ASN1Sequence  seq)
     {
@@ -98,6 +99,7 @@ public AlgorithmIdentifier getAlgorithm()
      * @deprecated use getAlgorithm()
      * @return    alg ID.
      */
+    @Deprecated
     public AlgorithmIdentifier getAlgorithmId()
     {
         return algId;
@@ -126,6 +128,7 @@ public ASN1Primitive parsePublicKey()
      * @deprecated use parsePublicKey
      * @return the public key as an ASN.1 primitive.
      */
+    @Deprecated
     public ASN1Primitive getPublicKey()
         throws IOException
     {
diff --git a/core/src/main/java/org/bouncycastle/crypto/AsymmetricCipherKeyPair.java b/core/src/main/java/org/bouncycastle/crypto/AsymmetricCipherKeyPair.java
@@ -31,6 +31,7 @@ public AsymmetricCipherKeyPair(
      * @param privateParam the corresponding private key parameters.
      * @deprecated use AsymmetricKeyParameter
      */
+    @Deprecated
     public AsymmetricCipherKeyPair(
         CipherParameters    publicParam,
         CipherParameters    privateParam)
diff --git a/core/src/main/java/org/bouncycastle/crypto/engines/AESEngine.java b/core/src/main/java/org/bouncycastle/crypto/engines/AESEngine.java
@@ -435,6 +435,7 @@ public static MultiBlockCipher newInstance()
      * default constructor - 128 bit block size.
      * @deprecated use AESEngine.newInstance()
      */
+    @Deprecated
     public AESEngine()
     {
         CryptoServicesRegistrar.checkConstraints(new DefaultServiceProperties(getAlgorithmName(), 256));
diff --git a/core/src/main/java/org/bouncycastle/crypto/engines/RSABlindedEngine.java b/core/src/main/java/org/bouncycastle/crypto/engines/RSABlindedEngine.java
@@ -28,7 +28,7 @@ public class RSABlindedEngine
      * initialise the RSA engine.
      *
      * @param forEncryption true if we are encrypting, false otherwise.
-     * @param param the necessary RSA key parameters.
+     * @param parameters the necessary RSA key parameters.
      */
     public void init(boolean forEncryption, CipherParameters parameters)
     {
diff --git a/core/src/main/java/org/bouncycastle/crypto/modes/SICBlockCipher.java b/core/src/main/java/org/bouncycastle/crypto/modes/SICBlockCipher.java
@@ -41,6 +41,7 @@ public static CTRModeCipher newInstance(BlockCipher cipher)
      * @param c the block cipher to be used.
      * @deprecated use newInstance() method.
      */
+    @Deprecated
     public SICBlockCipher(BlockCipher c)
     {
         super(c);
diff --git a/core/src/main/java/org/bouncycastle/crypto/params/SAKKEPublicKeyParameters.java b/core/src/main/java/org/bouncycastle/crypto/params/SAKKEPublicKeyParameters.java
@@ -191,7 +191,7 @@ public Digest getDigest()
     }
 
     /**
-     * @return The pairing result g = <P,P> (RFC 6508, Section 3.2)
+     * @return The pairing result {@code g = <P,P>} (RFC 6508, Section 3.2)
      */
     public BigInteger getG()
     {
diff --git a/core/src/main/java/org/bouncycastle/math/ec/ECCurve.java b/core/src/main/java/org/bouncycastle/math/ec/ECCurve.java
@@ -691,6 +691,7 @@ public static class Fp extends AbstractFp
         /**
          * @deprecated use constructor taking order/cofactor
          */
+        @Deprecated
         public Fp(BigInteger q, BigInteger a, BigInteger b)
         {
             this(q, a, b, null, null);
@@ -1153,6 +1154,7 @@ public static class F2m extends AbstractF2m
          * <code>F<sub>2<sup>m</sup></sub></code>.
          * @deprecated use constructor taking order/cofactor
          */
+        @Deprecated
         public F2m(
             int m,
             int k,
@@ -1211,6 +1213,7 @@ public F2m(
          * <code>F<sub>2<sup>m</sup></sub></code>.
          * @deprecated use constructor taking order/cofactor
          */
+        @Deprecated
         public F2m(
             int m,
             int k1,
diff --git a/core/src/main/java/org/bouncycastle/pqc/asn1/CMCEPublicKey.java b/core/src/main/java/org/bouncycastle/pqc/asn1/CMCEPublicKey.java
@@ -34,6 +34,7 @@ public CMCEPublicKey(byte[] t)
     /**
      * @deprecated use getInstance()
      */
+    @Deprecated
     public CMCEPublicKey(ASN1Sequence seq)
     {
         T = Arrays.clone(ASN1OctetString.getInstance(seq.getObjectAt(0)).getOctets());
diff --git a/core/src/main/java/org/bouncycastle/pqc/asn1/FalconPublicKey.java b/core/src/main/java/org/bouncycastle/pqc/asn1/FalconPublicKey.java
@@ -1,7 +1,13 @@
 package org.bouncycastle.pqc.asn1;
 
 
-import org.bouncycastle.asn1.*;
+import org.bouncycastle.asn1.ASN1EncodableVector;
+import org.bouncycastle.asn1.ASN1Object;
+import org.bouncycastle.asn1.ASN1OctetString;
+import org.bouncycastle.asn1.ASN1Primitive;
+import org.bouncycastle.asn1.ASN1Sequence;
+import org.bouncycastle.asn1.DEROctetString;
+import org.bouncycastle.asn1.DERSequence;
 import org.bouncycastle.util.Arrays;
 
 /**
@@ -32,6 +38,7 @@ public byte[] getH()
     /**
      * @deprecated use getInstance()
      */
+    @Deprecated
     public FalconPublicKey(ASN1Sequence seq)
     {
         h = Arrays.clone(ASN1OctetString.getInstance(seq.getObjectAt(0)).getOctets());
diff --git a/core/src/main/java/org/bouncycastle/pqc/asn1/PQCObjectIdentifiers.java b/core/src/main/java/org/bouncycastle/pqc/asn1/PQCObjectIdentifiers.java
@@ -86,35 +86,43 @@ public interface PQCObjectIdentifiers
     /**
      * @deprecated use xmss_SHA256ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_with_SHA256          = xmss_SHA256ph;
     /**
      * @deprecated use xmss_SHA512ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_with_SHA512 = xmss_SHA512ph;
     /**
      * @deprecated use xmss_SHAKE128ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_with_SHAKE128 = xmss_SHAKE128ph;
     /**
      * @deprecated use xmss_SHAKE256ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_with_SHAKE256        = xmss_SHAKE256ph;
 
     /**
      * @deprecated use xmss_mt_SHA256ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_mt_with_SHA256          = xmss_mt_SHA256ph;
     /**
      * @deprecated use xmss_mt_SHA512ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_mt_with_SHA512          = xmss_mt_SHA512ph;
     /**
      * @deprecated use xmss_mt_SHAKE128ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_mt_with_SHAKE128        = xmss_mt_SHAKE128ph;
     /**
      * @deprecated use xmss_mt_SHAKE256ph
      */
+    @Deprecated
     final ASN1ObjectIdentifier xmss_mt_with_SHAKE256        = xmss_mt_SHAKE256ph;
 
     /**
diff --git a/core/src/main/java/org/bouncycastle/pqc/asn1/SPHINCSPLUSPrivateKey.java b/core/src/main/java/org/bouncycastle/pqc/asn1/SPHINCSPLUSPrivateKey.java
@@ -68,6 +68,7 @@ public SPHINCSPLUSPrivateKey(int version, byte[] skseed, byte[] skprf, SPHINCSPL
     /**
      * @deprecated use getInstance()
      */
+    @Deprecated
     public SPHINCSPLUSPrivateKey(ASN1Sequence seq)
     {
         version = ASN1Integer.getInstance(seq.getObjectAt(0)).intValueExact();
diff --git a/core/src/main/java/org/bouncycastle/pqc/asn1/SPHINCSPLUSPublicKey.java b/core/src/main/java/org/bouncycastle/pqc/asn1/SPHINCSPLUSPublicKey.java
@@ -1,6 +1,12 @@
 package org.bouncycastle.pqc.asn1;
 
-import org.bouncycastle.asn1.*;
+import org.bouncycastle.asn1.ASN1EncodableVector;
+import org.bouncycastle.asn1.ASN1Object;
+import org.bouncycastle.asn1.ASN1OctetString;
+import org.bouncycastle.asn1.ASN1Primitive;
+import org.bouncycastle.asn1.ASN1Sequence;
+import org.bouncycastle.asn1.DEROctetString;
+import org.bouncycastle.asn1.DERSequence;
 import org.bouncycastle.util.Arrays;
 
 /**
@@ -29,6 +35,7 @@ public SPHINCSPLUSPublicKey(byte[] pkseed, byte[] pkroot)
     /**
      * @deprecated use getInstance()
      */
+    @Deprecated
     public SPHINCSPLUSPublicKey(ASN1Sequence seq)
     {
         pkseed = Arrays.clone(ASN1OctetString.getInstance(seq.getObjectAt(0)).getOctets());
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/crystals/dilithium/DilithiumParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/crystals/dilithium/DilithiumParameters.java
@@ -15,6 +15,7 @@ public class DilithiumParameters
      * @deprecated
      * obsolete to be removed
      */
+    @Deprecated
     private final boolean usingAES;// or shake
 
     private DilithiumParameters(String name, int k, boolean usingAES)
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/crystals/dilithium/DilithiumPrivateKeyParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/crystals/dilithium/DilithiumPrivateKeyParameters.java
@@ -63,6 +63,7 @@ public byte[] getK()
     }
 
     /** @deprecated Use {@link #getEncoded()} instead. */
+    @Deprecated
     public byte[] getPrivateKey()
     {
         return getEncoded();
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/mldsa/MLDSAPrivateKeyParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/mldsa/MLDSAPrivateKeyParameters.java
@@ -156,6 +156,7 @@ public byte[] getK()
     /**
      * @deprecated Use {@link #getEncoded()} instead.
      */
+    @Deprecated
     public byte[] getPrivateKey()
     {
         return getEncoded();
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/sphincsplus/SPHINCSPlusParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/sphincsplus/SPHINCSPlusParameters.java
@@ -193,6 +193,7 @@ public static SPHINCSPlusParameters getParams(Integer id)
      * @return the OID for the parameter set.
      * @deprecated Use {@link #getID()} instead
      */
+    @Deprecated
     public static Integer getID(SPHINCSPlusParameters params)
     {
         return params.getID();
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSMTPrivateKeyParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSMTPrivateKeyParameters.java
@@ -262,6 +262,7 @@ public XMSSMTPrivateKeyParameters build()
     /**
      * @deprecated use getEncoded() - this method will become private.
      */
+    @Deprecated
     public byte[] toByteArray()
     {
         synchronized (this)
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSMTPublicKeyParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSMTPublicKeyParameters.java
@@ -144,6 +144,7 @@ public XMSSMTPublicKeyParameters build()
     /**
      * @deprecated use getEncoded() - this method will become private.
      */
+    @Deprecated
     public byte[] toByteArray()
     {
         /* oid || root || seed */
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSPrivateKeyParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSPrivateKeyParameters.java
@@ -350,6 +350,7 @@ public XMSSPrivateKeyParameters build()
     /**
      * @deprecated use getEncoded() - this method will become private.
      */
+    @Deprecated
     public byte[] toByteArray()
     {
         synchronized (this)
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSPublicKeyParameters.java b/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSPublicKeyParameters.java
@@ -149,6 +149,7 @@ public XMSSPublicKeyParameters build()
     /**
      * @deprecated use getEncoded() - this method will become private.
      */
+    @Deprecated
     public byte[] toByteArray()
     {
         /* oid || root || seed */
diff --git a/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSStoreableObjectInterface.java b/core/src/main/java/org/bouncycastle/pqc/crypto/xmss/XMSSStoreableObjectInterface.java
diff --git a/core/src/main/java/org/bouncycastle/pqc/legacy/math/linearalgebra/ByteUtils.java b/core/src/main/java/org/bouncycastle/pqc/legacy/math/linearalgebra/ByteUtils.java
diff --git a/core/src/main/java/org/bouncycastle/pqc/legacy/math/linearalgebra/IntegerFunctions.java b/core/src/main/java/org/bouncycastle/pqc/legacy/math/linearalgebra/IntegerFunctions.java
diff --git a/core/src/main/java/org/bouncycastle/util/Fingerprint.java b/core/src/main/java/org/bouncycastle/util/Fingerprint.java
diff --git a/core/src/main/java/org/bouncycastle/util/Pack.java b/core/src/main/java/org/bouncycastle/util/Pack.java
diff --git a/core/src/main/jdk1.4/org/bouncycastle/asn1/ASN1ObjectIdentifier.java b/core/src/main/jdk1.4/org/bouncycastle/asn1/ASN1ObjectIdentifier.java
diff --git a/core/src/main/jdk1.4/org/bouncycastle/asn1/ASN1RelativeOID.java b/core/src/main/jdk1.4/org/bouncycastle/asn1/ASN1RelativeOID.java

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`*`
`11`	`11`	`* @deprecated Check for 'ASN1BitStringParser' instead`
`12`	`12`	`*/`
	`13`	`+@Deprecated`
`13`	`14`	`public class BERBitStringParser`
`14`	`15`	`implements ASN1BitStringParser`
`15`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`*`
`8`	`8`	`* @deprecated Check for 'ASN1SequenceParser' instead`
`9`	`9`	`*/`
	`10`	`+@Deprecated`
`10`	`11`	`public class BERSequenceParser`
`11`	`12`	`implements ASN1SequenceParser`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`*`
`8`	`8`	`* @deprecated Check for 'ASN1SetParser' instead`
`9`	`9`	`*/`
	`10`	`+@Deprecated`
`10`	`11`	`public class BERSetParser`
`11`	`12`	`implements ASN1SetParser`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ public class DERExternal`
`20`	`20`	`*`
`21`	`21`	`* @deprecated Use {@link DERExternal#DERExternal(DERSequence)} instead.`
`22`	`22`	`*/`
	`23`	`+ @Deprecated`
`23`	`24`	`public DERExternal(ASN1EncodableVector vector)`
`24`	`25`	`{`
`25`	`26`	`this(DERFactory.createSequence(vector));`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`*`
`9`	`9`	`* @deprecated Check for 'ASN1OctetStringParser' instead`
`10`	`10`	`*/`
	`11`	`+@Deprecated`
`11`	`12`	`public class DEROctetStringParser`
`12`	`13`	`implements ASN1OctetStringParser`
`13`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ public class DLExternal`
`20`	`20`	`*`
`21`	`21`	`* @deprecated Use {@link DLExternal#DLExternal(DLSequence)} instead.`
`22`	`22`	`*/`
	`23`	`+ @Deprecated`
`23`	`24`	`public DLExternal(ASN1EncodableVector vector)`
`24`	`25`	`{`
`25`	`26`	`this(DLFactory.createSequence(vector));`