AlgorithmId (kona-crypto 1.0.4 API)

java.lang.Object
- com.tencent.kona.sun.security.x509.AlgorithmId

All Implemented Interfaces:

DerEncoder, java.io.Serializable
```
public class AlgorithmId
extends java.lang.Object
implements java.io.Serializable, DerEncoder
```
This class identifies algorithms, such as cryptographic transforms, each of which may be associated with parameters. Instances of this base class are used when this runtime environment has no special knowledge of the algorithm type, and may also be used in other cases. Equivalence is defined according to OID and (where relevant) parameters.
Subclasses may be used, for example when the algorithm ID has associated parameters which some code (e.g. code using public keys) needs to have parsed. Two examples of such algorithms are Diffie-Hellman key exchange, and the Digital Signature Standard Algorithm (DSS/DSA).
The OID constants defined in this class correspond to some widely used algorithms, for which conventional string names have been defined. This class is not a general repository for OIDs, or for such string names. Note that the mappings between algorithm IDs and algorithm names is not one-to-one.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ObjectIdentifier`	`DSA_oid`
`static ObjectIdentifier`	`EC_oid`
`static ObjectIdentifier`	`ed25519_oid`
`static ObjectIdentifier`	`ed448_oid`
`protected byte[]`	`encodedParams` Parameters for this algorithm.
`static ObjectIdentifier`	`MD2_oid`
`static ObjectIdentifier`	`MD5_oid`
`static ObjectIdentifier`	`MGF1_oid`
`static ObjectIdentifier`	`RSAEncryption_oid`
`static ObjectIdentifier`	`RSASSA_PSS_oid`
`static ObjectIdentifier`	`SHA_oid`
`static ObjectIdentifier`	`SHA1withECDSA_oid`
`static ObjectIdentifier`	`SHA224_oid`
`static ObjectIdentifier`	`SHA224withECDSA_oid`
`static ObjectIdentifier`	`SHA256_oid`
`static ObjectIdentifier`	`SHA256withECDSA_oid`
`static ObjectIdentifier`	`SHA3_224_oid`
`static ObjectIdentifier`	`SHA3_256_oid`
`static ObjectIdentifier`	`SHA3_384_oid`
`static ObjectIdentifier`	`SHA3_512_oid`
`static ObjectIdentifier`	`SHA384_oid`
`static ObjectIdentifier`	`SHA384withECDSA_oid`
`static ObjectIdentifier`	`SHA512_224_oid`
`static ObjectIdentifier`	`SHA512_256_oid`
`static ObjectIdentifier`	`SHA512_oid`
`static ObjectIdentifier`	`SHA512withECDSA_oid`
`static ObjectIdentifier`	`SM2_OID`
`static ObjectIdentifier`	`SM3_OID`
`static ObjectIdentifier`	`SM3withSM2_OID`
`static ObjectIdentifier`	`x25519_oid`
`static ObjectIdentifier`	`x448_oid`

Constructor Summary

Constructors
Constructor and Description
`AlgorithmId()` Deprecated. use one of the other constructors.
`AlgorithmId(ObjectIdentifier oid)` Constructs a parameterless algorithm ID.
`AlgorithmId(ObjectIdentifier oid, java.security.AlgorithmParameters algparams)` Constructs an algorithm ID with algorithm parameters.
`AlgorithmId(ObjectIdentifier oid, DerValue params)` Constructs an algorithm ID with algorithm parameters as a DerValue.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`clearAliasOidsTable()`
`protected void`	`decodeParams()`
`byte[]`	`encode()` Returns the DER-encoded X.509 AlgorithmId as a byte array.
`void`	`encode(DerOutputStream out)` DER encode this object onto an output stream.
`boolean`	`equals(AlgorithmId other)` Returns true iff the argument indicates the same algorithm with the same parameters.
`boolean`	`equals(java.lang.Object other)` Compares this AlgorithmID to another.
`boolean`	`equals(ObjectIdentifier id)` Compares two algorithm IDs for equality.
`static AlgorithmId`	`get(java.security.AlgorithmParameters algparams)` Returns one of the algorithm IDs most commonly associated with this algorithm parameters.
`static AlgorithmId`	`get(java.lang.String algname)` Returns one of the algorithm IDs most commonly associated with this algorithm name.
`static AlgorithmId`	`getAlgorithmId(java.lang.String algname)` Deprecated. use the short get form of this method.
`byte[]`	`getEncodedParams()` Returns the DER encoded parameter, which can then be used to initialize java.security.AlgorithmParameters.
`java.lang.String`	`getName()` Returns a name for the algorithm which can be used by getInstance() call of a crypto primitive.
`ObjectIdentifier`	`getOID()` Returns the ISO OID for this algorithm.
`java.security.AlgorithmParameters`	`getParameters()`
`int`	`hashCode()` Returns a hashcode for this AlgorithmId.
`protected java.lang.String`	`paramsToString()` Provides a human-readable description of the algorithm parameters.
`static AlgorithmId`	`parse(DerValue val)` Parse (unmarshal) an ID from a DER sequence input value.
`java.lang.String`	`toString()` Returns a string describing the algorithm and its parameters.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - encodedParams
```
protected transient byte[] encodedParams
```
    Parameters for this algorithm. These are stored in unparsed DER-encoded form; subclasses can be made to automaticaly parse them so there is fast access to these parameters.
  - SM2_OID
```
public static final ObjectIdentifier SM2_OID
```
  - SM3_OID
```
public static final ObjectIdentifier SM3_OID
```
  - SM3withSM2_OID
```
public static final ObjectIdentifier SM3withSM2_OID
```
  - MD2_oid
```
public static final ObjectIdentifier MD2_oid
```
  - MD5_oid
```
public static final ObjectIdentifier MD5_oid
```
  - SHA_oid
```
public static final ObjectIdentifier SHA_oid
```
  - SHA224_oid
```
public static final ObjectIdentifier SHA224_oid
```
  - SHA256_oid
```
public static final ObjectIdentifier SHA256_oid
```
  - SHA384_oid
```
public static final ObjectIdentifier SHA384_oid
```
  - SHA512_oid
```
public static final ObjectIdentifier SHA512_oid
```
  - SHA512_224_oid
```
public static final ObjectIdentifier SHA512_224_oid
```
  - SHA512_256_oid
```
public static final ObjectIdentifier SHA512_256_oid
```
  - SHA3_224_oid
```
public static final ObjectIdentifier SHA3_224_oid
```
  - SHA3_256_oid
```
public static final ObjectIdentifier SHA3_256_oid
```
  - SHA3_384_oid
```
public static final ObjectIdentifier SHA3_384_oid
```
  - SHA3_512_oid
```
public static final ObjectIdentifier SHA3_512_oid
```
  - DSA_oid
```
public static final ObjectIdentifier DSA_oid
```
  - EC_oid
```
public static final ObjectIdentifier EC_oid
```
  - RSAEncryption_oid
```
public static final ObjectIdentifier RSAEncryption_oid
```
  - RSASSA_PSS_oid
```
public static final ObjectIdentifier RSASSA_PSS_oid
```
  - MGF1_oid
```
public static final ObjectIdentifier MGF1_oid
```
  - ed25519_oid
```
public static final ObjectIdentifier ed25519_oid
```
  - ed448_oid
```
public static final ObjectIdentifier ed448_oid
```
  - x25519_oid
```
public static final ObjectIdentifier x25519_oid
```
  - x448_oid
```
public static final ObjectIdentifier x448_oid
```
  - SHA1withECDSA_oid
```
public static final ObjectIdentifier SHA1withECDSA_oid
```
  - SHA224withECDSA_oid
```
public static final ObjectIdentifier SHA224withECDSA_oid
```
  - SHA256withECDSA_oid
```
public static final ObjectIdentifier SHA256withECDSA_oid
```
  - SHA384withECDSA_oid
```
public static final ObjectIdentifier SHA384withECDSA_oid
```
  - SHA512withECDSA_oid
```
public static final ObjectIdentifier SHA512withECDSA_oid
```
- Constructor Detail
  - AlgorithmId
```
@Deprecated
public AlgorithmId()
```
    Deprecated. use one of the other constructors.
    
    Constructs an algorithm ID which will be initialized separately, for example by deserialization.
  - AlgorithmId
```
public AlgorithmId(ObjectIdentifier oid)
```
    Constructs a parameterless algorithm ID.
    
    Parameters:
    
    oid - the identifier for the algorithm
  - AlgorithmId
```
public AlgorithmId(ObjectIdentifier oid,
                   java.security.AlgorithmParameters algparams)
```
    Constructs an algorithm ID with algorithm parameters.
    
    Parameters:
    
    oid - the identifier for the algorithm.
    
    algparams - the associated algorithm parameters, can be null.
  - AlgorithmId
```
public AlgorithmId(ObjectIdentifier oid,
                   DerValue params)
            throws java.io.IOException
```
    Constructs an algorithm ID with algorithm parameters as a DerValue.
    
    Parameters:
    
    oid - the identifier for the algorithm.
    
    params - the associated algorithm parameters, can be null.
    
    Throws:
    
    java.io.IOException
- Method Detail
  - decodeParams
```
protected void decodeParams()
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - encode
```
public void encode(DerOutputStream out)
            throws java.io.IOException
```
    DER encode this object onto an output stream. Implements the DerEncoder interface.
    
    Specified by:
    
    encode in interface DerEncoder
    
    Parameters:
    
    out - the output stream on which to write the DER encoding.
    
    Throws:
    
    java.io.IOException - on encoding error.
  - encode
```
public final byte[] encode()
                    throws java.io.IOException
```
    Returns the DER-encoded X.509 AlgorithmId as a byte array.
    
    Throws:
    
    java.io.IOException
  - getOID
```
public final ObjectIdentifier getOID()
```
    Returns the ISO OID for this algorithm. This is usually converted to a string and used as part of an algorithm name, for example "OID.1.3.14.3.2.13" style notation. Use the getName call when you do not need to ensure cross-system portability of algorithm names, or need a user-friendly name.
  - getName
```
public java.lang.String getName()
```
    Returns a name for the algorithm which can be used by getInstance() call of a crypto primitive. The name is usually more intelligible to humans than the algorithm's OID, but which won't necessarily be comprehensible on other systems. For example, this might return a name such as "MD5withRSA" for a signature algorithm on some systems. It also returns OID names like "1.2.3.4", when no particular name for the algorithm is known. The OID may also be recognized by getInstance() calls since an OID is usually defined as an alias for an algorithm by the security provider. In some special cases where the OID does not include enough info to return a Java standard algorithm name, an algorithm name that includes info on the params is returned: 1. For ecdsa-with-SHA2 plus hash algorithm (Ex: SHA-256), this method returns the "full" signature algorithm (Ex: SHA256withECDSA) directly. 2. For PBES2, this method returns the "full" cipher name containing the KDF and Enc algorithms (Ex: PBEWithHmacSHA256AndAES_256) directly.
  - getParameters
```
public java.security.AlgorithmParameters getParameters()
```
  - getEncodedParams
```
public byte[] getEncodedParams()
```
    Returns the DER encoded parameter, which can then be used to initialize java.security.AlgorithmParameters. Note that this* method should always return a new array as it is called directly by the JDK implementation of X509Certificate.getSigAlgParams() and X509CRL.getSigAlgParams(). Note: for ecdsa-with-SHA2 plus hash algorithm (Ex: SHA-256), this method returns null because getName() has already returned the "full" signature algorithm (Ex: SHA256withECDSA).
    
    Returns:
    
    DER encoded parameters, or null not present.
  - equals
```
public boolean equals(AlgorithmId other)
```
    Returns true iff the argument indicates the same algorithm with the same parameters.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Compares this AlgorithmID to another. If algorithm parameters are available, they are compared. Otherwise, just the object IDs for the algorithm are compared.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - preferably an AlgorithmId, else an ObjectIdentifier
  - equals
```
public final boolean equals(ObjectIdentifier id)
```
    Compares two algorithm IDs for equality. Returns true iff they are the same algorithm, ignoring algorithm parameters.
  - hashCode
```
public int hashCode()
```
    Returns a hashcode for this AlgorithmId.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hashcode for this AlgorithmId.
  - paramsToString
```
protected java.lang.String paramsToString()
```
    Provides a human-readable description of the algorithm parameters. This may be redefined by subclasses which parse those parameters.
  - toString
```
public java.lang.String toString()
```
    Returns a string describing the algorithm and its parameters.
    
    Overrides:
    
    toString in class java.lang.Object
  - parse
```
public static AlgorithmId parse(DerValue val)
                         throws java.io.IOException
```
    Parse (unmarshal) an ID from a DER sequence input value. This form parsing might be used when expanding a value which has already been partially unmarshaled as a set or sequence member.
    
    Parameters:
    
    val - the input value, which contains the algid and, if there are any parameters, those parameters.
    
    Returns:
    
    an ID for the algorithm. If the system is configured appropriately, this may be an instance of a class with some kind of special support for this algorithm. In that case, you may "narrow" the type of the ID.
    
    Throws:
    
    java.io.IOException - on error.
  - getAlgorithmId
```
@Deprecated
public static AlgorithmId getAlgorithmId(java.lang.String algname)
                                              throws java.security.NoSuchAlgorithmException
```
    Deprecated. use the short get form of this method.
    
    Returns one of the algorithm IDs most commonly associated with this algorithm name.
    
    Parameters:
    
    algname - the name being used
    
    Throws:
    
    java.security.NoSuchAlgorithmException - on error.
  - get
```
public static AlgorithmId get(java.lang.String algname)
                       throws java.security.NoSuchAlgorithmException
```
    Returns one of the algorithm IDs most commonly associated with this algorithm name.
    
    Parameters:
    
    algname - the name being used
    
    Throws:
    
    java.security.NoSuchAlgorithmException - on error.
  - get
```
public static AlgorithmId get(java.security.AlgorithmParameters algparams)
                       throws java.security.NoSuchAlgorithmException
```
    Returns one of the algorithm IDs most commonly associated with this algorithm parameters.
    
    Parameters:
    
    algparams - the associated algorithm parameters.
    
    Throws:
    
    java.security.NoSuchAlgorithmException - on error.
    
    java.lang.IllegalStateException - if algparams is not initialized or cannot be encoded
  - clearAliasOidsTable
```
public static void clearAliasOidsTable()
```

Class AlgorithmId

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

encodedParams

SM2_OID

SM3_OID

SM3withSM2_OID

MD2_oid

MD5_oid

SHA_oid

SHA224_oid

SHA256_oid

SHA384_oid

SHA512_oid

SHA512_224_oid

SHA512_256_oid

SHA3_224_oid

SHA3_256_oid

SHA3_384_oid

SHA3_512_oid

DSA_oid

EC_oid

RSAEncryption_oid

RSASSA_PSS_oid

MGF1_oid

ed25519_oid

ed448_oid

x25519_oid

x448_oid

SHA1withECDSA_oid

SHA224withECDSA_oid

SHA256withECDSA_oid

SHA384withECDSA_oid

SHA512withECDSA_oid

Constructor Detail

AlgorithmId

AlgorithmId

AlgorithmId

AlgorithmId

Method Detail

decodeParams

encode

encode

getOID

getName

getParameters

getEncodedParams

equals

equals

equals

hashCode

paramsToString

toString

parse

getAlgorithmId

get

get

clearAliasOidsTable