EntrustAlgorithmCapabilityList ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.asn1.cmpv1.gkm.EntrustAlgorithmCapabilityList

All Implemented Interfaces:

ASN1Type
```
public class EntrustAlgorithmCapabilityList
extends java.lang.Object
implements ASN1Type
```
This class implements the ASN.1 structure for AlgorithmCapabilityListBitString, as defined by Entrust.
This structure is used by the client in a PKIX-CMP transaction to indicate the algorithms it supports for use in PKIX-CMP to the server. Compliant clients must include this structure in the header of every PKIX-CMP message as a general information component. Java Toolkit 8.0 and later always provides an algorithm capability list.

The purpose of the algorithm capability list is to allow the client and server to communicate using a set of algorithms supported by both parties. A compliant server will always communicate using only algorithms indicated as supported by the client. If however the client does not support any algorithms that the server considers adequate, an error will be returned indicating the problem. If the client does not provide an algorithm capability list, the server will consider the client old and assume an algorithm capability list known to be commonly supported by old clients.

When provided, the algorithm capability list indicates the following:
- The sender is capable of verify signatures in PKIX-CMP messages (for message protection, proof-of-possession, and certificate validation) with any of the indicated signature algorithms.
- The sender is capable of verify MACs in PKIX-CMP messages (for message protection) with any of the indicated MAC algorithms.
- The sender is capable of decrypting encrypted content in PKIX-CMP messages (for private key transport and proof-of-possession) with any of the indicated symmetric cipher algorithms.
Note: The 0th bit will never be set and can always be ignored.
```
 AlgorithmCapabilityListBitString ::= BIT STRING {
    invalid            (0)
   ,ecdsa-sha1         (1)     
   ,ecdsa-sha224       (2) 
   ,ecdsa-sha256       (3) 
   ,ecdsa-sha384       (4) 
   ,ecdsa-sha512       (5) 
   ,rsapss-sha1        (6)     
   ,rsapss-sha224      (7)   
   ,rsapss-sha256      (8)   
   ,rsapss-sha384      (9)   
   ,rsapss-sha512     (10)   
   ,rsa-md2           (11)
   ,rsa-md5           (12)
   ,rsa-sha1          (13)
   ,rsa-sha224        (14)
   ,rsa-sha256        (15)
   ,rsa-sha384        (16)
   ,rsa-sha512        (17)
   ,dsa-sha1          (18)
   ,tripledes-dac-192 (19)
   ,hmac-sha1         (20)
   ,hmac-sha224       (21)
   ,hmac-sha256       (22)
   ,hmac-sha384       (23)
   ,hmac-sha512       (24)
   ,aes-cbc-128       (25)
   ,aes-cbc-192       (26)
   ,aes-cbc-256       (27)
   ,aes-gcm-128       (28)
   ,aes-gcm-192       (29)
   ,aes-gcm-256       (30)
   ,tripledes-cbc-192 (31)
   ,cast5-cbc-80      (32)
   ,cast5-cbc-128     (33)
   ,hmac-kdf-entrustpbkdf   (34)
   ,hmac-kdf-rfc4210-rfc4211(35)
   ,ecdh-x963sha1     (36)
   ,ecdh-x963sha256   (37)
 }
 
 entrustAlgorithmCapabilityList OBJECT-TYPE
     SYNTAX AlgorithmCapabilityListBitString
         ACCESS read-write
         STATUS mandatory
         ::= { 2 16 840 1 114027 50 19  }
 
```
Since:

8.0

Field Summary

Fields
Modifier and Type Field and Description

static ObjectID oid
The object identifier for EntrustAlgorithmCapabilityList.

Fields
Modifier and Type	Field and Description
`static ObjectID`	`oid` The object identifier for `EntrustAlgorithmCapabilityList`.

Constructor Summary

Constructors
Constructor and Description
`EntrustAlgorithmCapabilityList(ASN1Object obj)` Creates a new `EntrustAlgorithmCapabilityList` from an `ASN1Object`.
`EntrustAlgorithmCapabilityList(BinaryString entrustAlgorithmCapabilityList)` Creates a new `EntrustAlgorithmCapabilityList`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decode(ASN1Object obj)` Decodes an `EntrustAlgorithmCapabilityList` from an `ASN1Object`.
`BinaryString`	`getEntrustAlgorithmCapabilityList()` Returns the Entrust algorithm capability list value.
`boolean`	`isAesCbc128Supported()` Indicates whether or not the sender supports the `aes-cbc-128` algorithm.
`boolean`	`isAesCbc192Supported()` Indicates whether or not the sender supports the `aes-cbc-192` algorithm.
`boolean`	`isAesCbc256Supported()` Indicates whether or not the sender supports the `aes-cbc-256` algorithm.
`boolean`	`isAesGcm128Supported()` Indicates whether or not the sender supports the `aes-gcm-128` algorithm.
`boolean`	`isAesGcm192Supported()` Indicates whether or not the sender supports the `aes-gcm-192` algorithm.
`boolean`	`isAesGcm256Supported()` Indicates whether or not the sender supports the `aes-gcm-256` algorithm.
`boolean`	`isCast5Cbc128Supported()` Indicates whether or not the sender supports the `cast5-cbc-128` algorithm.
`boolean`	`isCast5Cbc80Supported()` Indicates whether or not the sender supports the `cast5-cbc-80` algorithm.
`boolean`	`isDsaSha1Supported()` Indicates whether or not the sender supports the `dsa-sha1` algorithm.
`boolean`	`isEcdhX963Sha1Supported()` Indicates whether or not the sender supports the `ecdh-x963sha1` algorithm.
`boolean`	`isEcdhX963Sha256Supported()` Indicates whether or not the sender supports the `ecdh-x963sha256` algorithm.
`boolean`	`isEcdsaSha1Supported()` Indicates whether or not the sender supports the `ecdsa-sha1` algorithm.
`boolean`	`isEcdsaSha224Supported()` Indicates whether or not the sender supports the `ecdsa-sha224` algorithm.
`boolean`	`isEcdsaSha256Supported()` Indicates whether or not the sender supports the `ecdsa-sha256` algorithm.
`boolean`	`isEcdsaSha384upported()` Indicates whether or not the sender supports the `ecdsa-sha384` algorithm.
`boolean`	`isEcdsaSha512Supported()` Indicates whether or not the sender supports the `ecdsa-sha512` algorithm.
`boolean`	`isHmacKdfEntrustPbkdfSupported()` Indicates whether or not the sender supports the `hmac-kdf-entrustpbkdf` algorithm.
`boolean`	`isHmacKdfRfc4210Rfc4211Supported()` Indicates whether or not the sender supports the `hmac-kdf-rfc4210-rfc4211` algorithm.
`boolean`	`isHmacSha1Supported()` Indicates whether or not the sender supports the `hmac-sha1` algorithm.
`boolean`	`isHmacSha224Supported()` Indicates whether or not the sender supports the `hmac-sha224` algorithm.
`boolean`	`isHmacSha256Supported()` Indicates whether or not the sender supports the `hmac-sha256` algorithm.
`boolean`	`isHmacSha384Supported()` Indicates whether or not the sender supports the `hmac-sha384` algorithm.
`boolean`	`isHmacSha512Supported()` Indicates whether or not the sender supports the `hmac-sha512` algorithm.
`boolean`	`isRsaMd2Supported()` Indicates whether or not the sender supports the `rsa-md2` algorithm.
`boolean`	`isRsaMd5Supported()` Indicates whether or not the sender supports the `rsa-md5` algorithm.
`boolean`	`isRsaPssSha1Supported()` Indicates whether or not the sender supports the `rsapss-sha1` algorithm.
`boolean`	`isRsaPssSha224Supported()` Indicates whether or not the sender supports the `rsapss-sha224` algorithm.
`boolean`	`isRsaPssSha256Supported()` Indicates whether or not the sender supports the `rsapss-sha256` algorithm.
`boolean`	`isRsaPssSha384Supported()` Indicates whether or not the sender supports the `rsapss-sha384` algorithm.
`boolean`	`isRsaPssSha512Supported()` Indicates whether or not the sender supports the `rsapss-sha512` algorithm.
`boolean`	`isRsaSha1Supported()` Indicates whether or not the sender supports the `rsa-sha1` algorithm.
`boolean`	`isRsaSha224Supported()` Indicates whether or not the sender supports the `rsa-sha224` algorithm.
`boolean`	`isRsaSha256Supported()` Indicates whether or not the sender supports the `rsa-sha256` algorithm.
`boolean`	`isRsaSha384Supported()` Indicates whether or not the sender supports the `rsa-sha384` algorithm.
`boolean`	`isRsaSha512Supported()` Indicates whether or not the sender supports the `rsa-sha512` algorithm.
`boolean`	`isTripleDesCbc192Supported()` Indicates whether or not the sender supports the `tripledes-cbc-192` algorithm.
`boolean`	`isTripleDesDac192Supported()` Indicates whether or not the sender supports the `tripledes-dac-192` algorithm.
`void`	`setEntrustAlgorithmCapabilityList(BinaryString entrustAlgorithmCapabilityList)` Sets the Entrust algorithm capability list value.
`ASN1Object`	`toASN1Object()` Encodes this `EntrustAlgorithmCapabilityList` object as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `EntrustCapabilityList` object.

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

- Field Detail
  - oid
```
public static final ObjectID oid
```
    The object identifier for EntrustAlgorithmCapabilityList.
- Constructor Detail
  - EntrustAlgorithmCapabilityList
```
public EntrustAlgorithmCapabilityList(BinaryString entrustAlgorithmCapabilityList)
```
    Creates a new EntrustAlgorithmCapabilityList.
    
    Parameters:
    
    entrustAlgorithmCapabilityList - the Entrust algorithm capability list value
    
    Throws:
    
    java.lang.IllegalArgumentException - if the parameter is null
  - EntrustAlgorithmCapabilityList
```
public EntrustAlgorithmCapabilityList(ASN1Object obj)
                               throws CodingException
```
    Creates a new EntrustAlgorithmCapabilityList from an ASN1Object. The ASN1Object must be an AlgorithmCapabilityListBitString structure.
    
    Parameters:
    
    obj - the ASN.1 representation of an AlgorithmCapabilityListBitString structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
- Method Detail
  - getEntrustAlgorithmCapabilityList
```
public BinaryString getEntrustAlgorithmCapabilityList()
```
    Returns the Entrust algorithm capability list value.
    
    Returns:
    
    the Entrust algorithm capability list value
  - setEntrustAlgorithmCapabilityList
```
public void setEntrustAlgorithmCapabilityList(BinaryString entrustAlgorithmCapabilityList)
```
    Sets the Entrust algorithm capability list value.
    
    Parameters:
    
    entrustAlgorithmCapabilityList - the Entrust algorithm capability list value
    
    Throws:
    
    java.lang.IllegalArgumentException - if the parameter is null
  - isEcdsaSha1Supported
```
public boolean isEcdsaSha1Supported()
```
    Indicates whether or not the sender supports the ecdsa-sha1 algorithm.
    
    Returns:
    
    true if the 'ecdsa-sha1' bit is set; false otherwise
  - isEcdsaSha224Supported
```
public boolean isEcdsaSha224Supported()
```
    Indicates whether or not the sender supports the ecdsa-sha224 algorithm.
    
    Returns:
    
    true if the 'ecdsa-sha224' bit is set; false otherwise
  - isEcdsaSha256Supported
```
public boolean isEcdsaSha256Supported()
```
    Indicates whether or not the sender supports the ecdsa-sha256 algorithm.
    
    Returns:
    
    true if the 'ecdsa-sha256' bit is set; false otherwise
  - isEcdsaSha384upported
```
public boolean isEcdsaSha384upported()
```
    Indicates whether or not the sender supports the ecdsa-sha384 algorithm.
    
    Returns:
    
    true if the 'ecdsa-sha384' bit is set; false otherwise
  - isEcdsaSha512Supported
```
public boolean isEcdsaSha512Supported()
```
    Indicates whether or not the sender supports the ecdsa-sha512 algorithm.
    
    Returns:
    
    true if the 'ecdsa-sha512' bit is set; false otherwise
  - isRsaPssSha1Supported
```
public boolean isRsaPssSha1Supported()
```
    Indicates whether or not the sender supports the rsapss-sha1 algorithm.
    
    Returns:
    
    true if the 'rsapss-sha1; bit is set; false otherwise
  - isRsaPssSha224Supported
```
public boolean isRsaPssSha224Supported()
```
    Indicates whether or not the sender supports the rsapss-sha224 algorithm.
    
    Returns:
    
    true if the 'rsapss-sha224' bit is set; false otherwise
  - isRsaPssSha256Supported
```
public boolean isRsaPssSha256Supported()
```
    Indicates whether or not the sender supports the rsapss-sha256 algorithm.
    
    Returns:
    
    true if the 'rsapss-sha256' bit is set; false otherwise
  - isRsaPssSha384Supported
```
public boolean isRsaPssSha384Supported()
```
    Indicates whether or not the sender supports the rsapss-sha384 algorithm.
    
    Returns:
    
    true if the 'rsapss-sha384' bit is set; false otherwise
  - isRsaPssSha512Supported
```
public boolean isRsaPssSha512Supported()
```
    Indicates whether or not the sender supports the rsapss-sha512 algorithm.
    
    Returns:
    
    true if the 'rsapss-sha512' bit is set; false otherwise
  - isRsaMd2Supported
```
public boolean isRsaMd2Supported()
```
    Indicates whether or not the sender supports the rsa-md2 algorithm.
    
    Returns:
    
    true if the 'rsa-md2' bit is set; false otherwise
  - isRsaMd5Supported
```
public boolean isRsaMd5Supported()
```
    Indicates whether or not the sender supports the rsa-md5 algorithm.
    
    Returns:
    
    true if the 'rsa-md5' bit is set; false otherwise
  - isRsaSha1Supported
```
public boolean isRsaSha1Supported()
```
    Indicates whether or not the sender supports the rsa-sha1 algorithm.
    
    Returns:
    
    true if the 'rsa-sha1' bit is set; false otherwise
  - isRsaSha224Supported
```
public boolean isRsaSha224Supported()
```
    Indicates whether or not the sender supports the rsa-sha224 algorithm.
    
    Returns:
    
    true if the 'rsa-sha224' bit is set; false otherwise
  - isRsaSha256Supported
```
public boolean isRsaSha256Supported()
```
    Indicates whether or not the sender supports the rsa-sha256 algorithm.
    
    Returns:
    
    true if the 'rsa-sha256' bit is set; false otherwise
  - isRsaSha384Supported
```
public boolean isRsaSha384Supported()
```
    Indicates whether or not the sender supports the rsa-sha384 algorithm.
    
    Returns:
    
    true if the 'rsa-sha384' bit is set; false otherwise
  - isRsaSha512Supported
```
public boolean isRsaSha512Supported()
```
    Indicates whether or not the sender supports the rsa-sha512 algorithm.
    
    Returns:
    
    true if the 'rsa-sha512' bit is set; false otherwise
  - isDsaSha1Supported
```
public boolean isDsaSha1Supported()
```
    Indicates whether or not the sender supports the dsa-sha1 algorithm.
    
    Returns:
    
    true if the 'dsa-sha1' bit is set; false otherwise
  - isTripleDesDac192Supported
```
public boolean isTripleDesDac192Supported()
```
    Indicates whether or not the sender supports the tripledes-dac-192 algorithm.
    
    Returns:
    
    true if the 'tripledes-dac-192' bit is set; false otherwise
  - isHmacSha1Supported
```
public boolean isHmacSha1Supported()
```
    Indicates whether or not the sender supports the hmac-sha1 algorithm.
    
    Returns:
    
    true if the 'hmac-sha1' bit is set; false otherwise
  - isHmacSha224Supported
```
public boolean isHmacSha224Supported()
```
    Indicates whether or not the sender supports the hmac-sha224 algorithm.
    
    Returns:
    
    true if the 'hmac-sha224' bit is set; false otherwise
  - isHmacSha256Supported
```
public boolean isHmacSha256Supported()
```
    Indicates whether or not the sender supports the hmac-sha256 algorithm.
    
    Returns:
    
    true if the 'hmac-sha256' bit is set; false otherwise
  - isHmacSha384Supported
```
public boolean isHmacSha384Supported()
```
    Indicates whether or not the sender supports the hmac-sha384 algorithm.
    
    Returns:
    
    true if the 'hmac-sha384' bit is set; false otherwise
  - isHmacSha512Supported
```
public boolean isHmacSha512Supported()
```
    Indicates whether or not the sender supports the hmac-sha512 algorithm.
    
    Returns:
    
    true if the 'hmac-sha512' bit is set; false otherwise
  - isAesCbc128Supported
```
public boolean isAesCbc128Supported()
```
    Indicates whether or not the sender supports the aes-cbc-128 algorithm.
    
    Returns:
    
    true if the 'aes-cbc-128' bit is set; false otherwise
  - isAesCbc192Supported
```
public boolean isAesCbc192Supported()
```
    Indicates whether or not the sender supports the aes-cbc-192 algorithm.
    
    Returns:
    
    true if the 'aes-cbc-192' bit is set; false otherwise
  - isAesCbc256Supported
```
public boolean isAesCbc256Supported()
```
    Indicates whether or not the sender supports the aes-cbc-256 algorithm.
    
    Returns:
    
    true if the 'aes-cbc-256' bit is set; false otherwise
  - isAesGcm128Supported
```
public boolean isAesGcm128Supported()
```
    Indicates whether or not the sender supports the aes-gcm-128 algorithm.
    
    Returns:
    
    true if the 'aes-gcm-128' bit is set; false otherwise
  - isAesGcm192Supported
```
public boolean isAesGcm192Supported()
```
    Indicates whether or not the sender supports the aes-gcm-192 algorithm.
    
    Returns:
    
    true if the 'aes-gcm-192' bit is set; false otherwise
  - isAesGcm256Supported
```
public boolean isAesGcm256Supported()
```
    Indicates whether or not the sender supports the aes-gcm-256 algorithm.
    
    Returns:
    
    true if the 'aes-gcm-256' bit is set; false otherwise
  - isTripleDesCbc192Supported
```
public boolean isTripleDesCbc192Supported()
```
    Indicates whether or not the sender supports the tripledes-cbc-192 algorithm.
    
    Returns:
    
    true if the 'tripledes-cbc-192' bit is set; false otherwise
  - isCast5Cbc80Supported
```
public boolean isCast5Cbc80Supported()
```
    Indicates whether or not the sender supports the cast5-cbc-80 algorithm.
    
    Returns:
    
    true if the 'cast5-cbc-80' bit is set; false otherwise
  - isCast5Cbc128Supported
```
public boolean isCast5Cbc128Supported()
```
    Indicates whether or not the sender supports the cast5-cbc-128 algorithm.
    
    Returns:
    
    true if the 'cast5-cbc-128' bit is set; false otherwise
  - isHmacKdfEntrustPbkdfSupported
```
public boolean isHmacKdfEntrustPbkdfSupported()
```
    Indicates whether or not the sender supports the hmac-kdf-entrustpbkdf algorithm.
    
    Returns:
    
    true if the 'hmac-kdf-entrustpbkdf' bit is set; false otherwise
  - isHmacKdfRfc4210Rfc4211Supported
```
public boolean isHmacKdfRfc4210Rfc4211Supported()
```
    Indicates whether or not the sender supports the hmac-kdf-rfc4210-rfc4211 algorithm.
    
    Returns:
    
    true if the 'hmac-kdf-rfc4210-rfc4211' bit is set; false otherwise
  - isEcdhX963Sha1Supported
```
public boolean isEcdhX963Sha1Supported()
```
    Indicates whether or not the sender supports the ecdh-x963sha1 algorithm.
    
    Returns:
    
    true if the 'ecdh-x963sha1' bit is set; false otherwise
  - isEcdhX963Sha256Supported
```
public boolean isEcdhX963Sha256Supported()
```
    Indicates whether or not the sender supports the ecdh-x963sha256 algorithm.
    
    Returns:
    
    true if the 'ecdh-x963sha256' bit is set; false otherwise
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes an EntrustAlgorithmCapabilityList from an ASN1Object. The ASN1Object must be an AlgorithmCapabilityListBitString structure.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    
    obj - an ASN.1 representation of an AlgorithmCapabilityListBitString structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Encodes this EntrustAlgorithmCapabilityList object as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    Returns:
    
    an ASN.1 representation of the AlgorithmCapabilityListBitString structure
  - toString
```
public java.lang.String toString()
```
    Creates a text representation of the ASN.1 structure of this EntrustCapabilityList object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a text representation of the ASN.1 structure of this object

Class EntrustAlgorithmCapabilityList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

oid

Constructor Detail

EntrustAlgorithmCapabilityList

EntrustAlgorithmCapabilityList

Method Detail

getEntrustAlgorithmCapabilityList

setEntrustAlgorithmCapabilityList

isEcdsaSha1Supported

isEcdsaSha224Supported

isEcdsaSha256Supported

isEcdsaSha384upported

isEcdsaSha512Supported

isRsaPssSha1Supported

isRsaPssSha224Supported

isRsaPssSha256Supported

isRsaPssSha384Supported

isRsaPssSha512Supported

isRsaMd2Supported

isRsaMd5Supported

isRsaSha1Supported

isRsaSha224Supported

isRsaSha256Supported

isRsaSha384Supported

isRsaSha512Supported

isDsaSha1Supported

isTripleDesDac192Supported

isHmacSha1Supported

isHmacSha224Supported

isHmacSha256Supported

isHmacSha384Supported

isHmacSha512Supported

isAesCbc128Supported

isAesCbc192Supported

isAesCbc256Supported

isAesGcm128Supported

isAesGcm192Supported

isAesGcm256Supported

isTripleDesCbc192Supported

isCast5Cbc80Supported

isCast5Cbc128Supported

isHmacKdfEntrustPbkdfSupported

isHmacKdfRfc4210Rfc4211Supported

isEcdhX963Sha1Supported

isEcdhX963Sha256Supported

decode

toASN1Object

toString