PKCS9Attribute (kona-pkix 1.0.7.1 API)

java.lang.Object
- com.tencent.kona.sun.security.pkcs.PKCS9Attribute

All Implemented Interfaces:: com.tencent.kona.sun.security.util.DerEncoder

public class PKCS9Attribute
extends java.lang.Object
implements com.tencent.kona.sun.security.util.DerEncoder

Class supporting any PKCS9 attributes. Supports DER decoding/encoding and access to attribute values.

Type/Class Table

The following table shows the correspondence between PKCS9 attribute types and value component classes. For types not listed here, its name is the OID in string form, its value is a (single-valued) byte array that is the SET's encoding.

Object Identifier	Attribute Name	Type	Value Class
1.2.840.113549.1.9.1	EmailAddress	Multi-valued	`String[]`
1.2.840.113549.1.9.2	UnstructuredName	Multi-valued	`String[]`
1.2.840.113549.1.9.3	ContentType	Single-valued	`ObjectIdentifier`
1.2.840.113549.1.9.4	MessageDigest	Single-valued	`byte[]`
1.2.840.113549.1.9.5	SigningTime	Single-valued	`Date`
1.2.840.113549.1.9.6	Countersignature	Multi-valued	`SignerInfo[]`
1.2.840.113549.1.9.7	ChallengePassword	Single-valued	`String`
1.2.840.113549.1.9.8	UnstructuredAddress	Single-valued	`String`
1.2.840.113549.1.9.9	ExtendedCertificateAttributes	Multi-valued	(not supported)
1.2.840.113549.1.9.10	IssuerAndSerialNumber	Single-valued	(not supported)
1.2.840.113549.1.9.{11,12}	RSA DSI proprietary	Single-valued	(not supported)
1.2.840.113549.1.9.13	S/MIME unused assignment	Single-valued	(not supported)
1.2.840.113549.1.9.14	ExtensionRequest	Single-valued	CertificateExtensions
1.2.840.113549.1.9.15	SMIMECapability	Single-valued	(not supported)
1.2.840.113549.1.9.16.2.12	SigningCertificate	Single-valued	SigningCertificateInfo
1.2.840.113549.1.9.16.2.14	SignatureTimestampToken	Single-valued	byte[]
1.2.840.113549.1.9.16.2.52	CMSAlgorithmProtection	Single-valued	byte[]

Field Summary

Fields
Modifier and Type	Field and Description
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`CHALLENGE_PASSWORD_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`CMS_ALGORITHM_PROTECTION_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`CONTENT_TYPE_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`COUNTERSIGNATURE_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`EMAIL_ADDRESS_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`EXTENDED_CERTIFICATE_ATTRIBUTES_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`EXTENSION_REQUEST_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`ISSUER_SERIALNUMBER_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`MESSAGE_DIGEST_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`SIGNATURE_TIMESTAMP_TOKEN_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`SIGNING_CERTIFICATE_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`SIGNING_TIME_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`UNSTRUCTURED_ADDRESS_OID`
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`UNSTRUCTURED_NAME_OID`

Constructor Summary

Constructors
Constructor and Description
`PKCS9Attribute(com.tencent.kona.sun.security.util.DerValue derVal)` Construct a PKCS9Attribute from its encoding on an input stream.
`PKCS9Attribute(com.tencent.kona.sun.security.util.ObjectIdentifier oid, java.lang.Object value)` Construct an attribute object from the attribute's OID and value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`encode(com.tencent.kona.sun.security.util.DerOutputStream out)` Write the DER encoding of this attribute to an output stream.
`java.lang.String`	`getName()` Return the name of this attribute.
`static java.lang.String`	`getName(com.tencent.kona.sun.security.util.ObjectIdentifier oid)` Return the attribute name for a given OID or null if we don't recognize the oid.
`com.tencent.kona.sun.security.util.ObjectIdentifier`	`getOID()` Return the OID of this attribute.
`static com.tencent.kona.sun.security.util.ObjectIdentifier`	`getOID(java.lang.String name)` Return the OID for a given attribute name or null if we don't recognize the name.
`java.lang.Object`	`getValue()` Get the value of this attribute.
`boolean`	`isKnown()` Returns if the attribute is known.
`boolean`	`isSingleValued()` Show whether this attribute is single-valued.
`java.lang.String`	`toString()` Returns a string representation of this attribute.

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

- Field Detail
  - EMAIL_ADDRESS_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier EMAIL_ADDRESS_OID
```
  - UNSTRUCTURED_NAME_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier UNSTRUCTURED_NAME_OID
```
  - CONTENT_TYPE_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier CONTENT_TYPE_OID
```
  - MESSAGE_DIGEST_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier MESSAGE_DIGEST_OID
```
  - SIGNING_TIME_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier SIGNING_TIME_OID
```
  - COUNTERSIGNATURE_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier COUNTERSIGNATURE_OID
```
  - CHALLENGE_PASSWORD_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier CHALLENGE_PASSWORD_OID
```
  - UNSTRUCTURED_ADDRESS_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier UNSTRUCTURED_ADDRESS_OID
```
  - EXTENDED_CERTIFICATE_ATTRIBUTES_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier EXTENDED_CERTIFICATE_ATTRIBUTES_OID
```
  - ISSUER_SERIALNUMBER_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier ISSUER_SERIALNUMBER_OID
```
  - EXTENSION_REQUEST_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier EXTENSION_REQUEST_OID
```
  - SIGNING_CERTIFICATE_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier SIGNING_CERTIFICATE_OID
```
  - SIGNATURE_TIMESTAMP_TOKEN_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier SIGNATURE_TIMESTAMP_TOKEN_OID
```
  - CMS_ALGORITHM_PROTECTION_OID
```
public static final com.tencent.kona.sun.security.util.ObjectIdentifier CMS_ALGORITHM_PROTECTION_OID
```
- Constructor Detail
  - PKCS9Attribute
```
public PKCS9Attribute(com.tencent.kona.sun.security.util.ObjectIdentifier oid,
                      java.lang.Object value)
               throws java.lang.IllegalArgumentException
```
    Construct an attribute object from the attribute's OID and value. If the attribute is single-valued, provide only one value. If the attribute is multi-valued, provide an array containing all the values. Arrays of length zero are accepted, though probably useless.
    The table gives the class that value must have for a given attribute.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value has the wrong type.
  - PKCS9Attribute
```
public PKCS9Attribute(com.tencent.kona.sun.security.util.DerValue derVal)
               throws java.io.IOException
```
    Construct a PKCS9Attribute from its encoding on an input stream.
    
    Parameters:
    
    derVal - the DerValue representing the DER encoding of the attribute.
    
    Throws:
    
    java.io.IOException - on parsing error.
- Method Detail
  - encode
```
public void encode(com.tencent.kona.sun.security.util.DerOutputStream out)
```
    Write the DER encoding of this attribute to an output stream.
    N.B.: This method always encodes values of ChallengePassword and UnstructuredAddress attributes as ASN.1 PrintableStrings, without checking whether they should be encoded as T61Strings.
    
    Specified by:
    
    encode in interface com.tencent.kona.sun.security.util.DerEncoder
  - isKnown
```
public boolean isKnown()
```
    Returns if the attribute is known. Unknown attributes can be created from DER encoding with unknown OIDs.
  - getValue
```
public java.lang.Object getValue()
```
    Get the value of this attribute. If the attribute is single-valued, return just the one value. If the attribute is multi-valued, return an array containing all the values. It is possible for this array to be of length 0.
    The table gives the class of the value returned, depending on the type of this attribute.
  - isSingleValued
```
public boolean isSingleValued()
```
    Show whether this attribute is single-valued.
  - getOID
```
public com.tencent.kona.sun.security.util.ObjectIdentifier getOID()
```
    Return the OID of this attribute.
  - getName
```
public java.lang.String getName()
```
    Return the name of this attribute.
  - getOID
```
public static com.tencent.kona.sun.security.util.ObjectIdentifier getOID(java.lang.String name)
```
    Return the OID for a given attribute name or null if we don't recognize the name.
  - getName
```
public static java.lang.String getName(com.tencent.kona.sun.security.util.ObjectIdentifier oid)
```
    Return the attribute name for a given OID or null if we don't recognize the oid.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this attribute.
    
    Overrides:
    
    toString in class java.lang.Object

Class PKCS9Attribute

Type/Class Table

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMAIL_ADDRESS_OID

UNSTRUCTURED_NAME_OID

CONTENT_TYPE_OID

MESSAGE_DIGEST_OID

SIGNING_TIME_OID

COUNTERSIGNATURE_OID

CHALLENGE_PASSWORD_OID

UNSTRUCTURED_ADDRESS_OID

EXTENDED_CERTIFICATE_ATTRIBUTES_OID

ISSUER_SERIALNUMBER_OID

EXTENSION_REQUEST_OID

SIGNING_CERTIFICATE_OID

SIGNATURE_TIMESTAMP_TOKEN_OID

CMS_ALGORITHM_PROTECTION_OID

Constructor Detail

PKCS9Attribute

PKCS9Attribute

Method Detail

encode

isKnown

getValue

isSingleValued

getOID

getName

getOID

getName

toString