Attribute (PKCS#11 wrapper 1.4.2 API)

java.lang.Object
- iaik.pkcs.pkcs11.objects.Attribute

Direct Known Subclasses:

AttributeArray, BooleanAttribute, ByteArrayAttribute, CharArrayAttribute, DateAttribute, LongAttribute, MechanismArrayAttribute, OtherAttribute
```
public abstract class Attribute
extends Object
```
This is the base-class for all types of attributes. In general, all PKCS#11 objects are just a collection of attributes. PKCS#11 specifies which attributes each type of objects must have. In some cases, attributes are optional (e.g. in RSAPrivateKey). In such a case, this attribute will return false when the application calls isPresent() on this attribute. This means, that the object does not possess this attribute (maybe even though it should, but not all drivers seem to implement the standard correctly). Handling attributes in this fashion ensures that this library can work also with drivers that are not fully compliant. Moreover, certain attributes can be sensitive; i.e. their values cannot be read, e.g. the private exponent of a RSA private key.

Version:

1.0

Author:

Karl Scheibelhofer

Field Summary

Fields
Modifier and Type	Field and Description
`static Long`	`AC_ISSUER`
`static Long`	`ALLOWED_MECHANISMS`
`static Long`	`ALWAYS_AUTHENTICATE`
`static Long`	`ALWAYS_SENSITIVE`
`static Long`	`APPLICATION`
`static Long`	`ATTR_TYPES`
`protected static Hashtable<Long,Class<?>>`	`attributeClasses`
`protected static Hashtable<Long,String>`	`attributeNames`
`static Long`	`AUTH_PIN_FLAGS`
`static Long`	`BASE`
`static Long`	`BITS_PER_PIXEL`
`static Long`	`CERTIFICATE_CATEGORY`
`static Long`	`CERTIFICATE_TYPE`
`static Long`	`CHAR_COLUMNS`
`static Long`	`CHAR_ROWS`
`static Long`	`CHAR_SETS`
`static Long`	`CHECK_VALUE`
`protected sun.security.pkcs11.wrapper.CK_ATTRIBUTE`	`ckAttribute` The CK_ATTRIBUTE that is used to hold the PKCS#11 type of this attribute and the value.
`static Long`	`CLASS`
`static Long`	`COEFFICIENT`
`static Long`	`COLOR`
`static Long`	`DECRYPT`
`static Long`	`DERIVE`
`static Long`	`EC_PARAMS`
`static Long`	`EC_POINT`
`static Long`	`ENCODING_METHODS`
`static Long`	`ENCRYPT`
`static Long`	`END_DATE`
`static Long`	`EXPONENT_1`
`static Long`	`EXPONENT_2`
`static Long`	`EXTRACTABLE`
`static Long`	`HAS_RESET`
`static Long`	`HASH_OF_ISSUER_PUBLIC_KEY`
`static Long`	`HASH_OF_SUBJECT_PUBLIC_KEY`
`static Long`	`HW_FEATURE_TYPE`
`static Long`	`ID`
`static Long`	`ISSUER`
`static Long`	`JAVA_MIDP_SECURITY_DOMAIN`
`static Long`	`KEY_GEN_MECHANISM`
`static Long`	`KEY_TYPE`
`static Long`	`LABEL`
`static Long`	`LOCAL`
`static Long`	`MECHANISM_TYPE`
`static Long`	`MIME_TYPES`
`static Long`	`MODIFIABLE`
`static Long`	`MODULUS`
`static Long`	`MODULUS_BITS`
`static Long`	`NEVER_EXTRACTABLE`
`static Long`	`OBJECT_ID`
`static Long`	`OWNER`
`static Long`	`PIXEL_X`
`static Long`	`PIXEL_Y`
`protected boolean`	`present` True, if the object really possesses this attribute.
`static Long`	`PRIME`
`static Long`	`PRIME_1`
`static Long`	`PRIME_2`
`static Long`	`PRIME_BITS`
`static Long`	`PRIVATE`
`static Long`	`PRIVATE_EXPONENT`
`static Long`	`PUBLIC_EXPONENT`
`static Long`	`RESET_ON_INIT`
`static Long`	`RESOLUTION`
`static Long`	`SECONDARY_AUTH`
`protected boolean`	`sensitive` True, if this attribute is sensitive.
`static Long`	`SENSITIVE`
`static Long`	`SERIAL_NUMBER`
`static Long`	`SIGN`
`static Long`	`SIGN_RECOVER`
`static Long`	`START_DATE`
`static Long`	`SUB_PRIME_BITS`
`static Long`	`SUBJECT`
`static Long`	`SUBPRIME`
`static Long`	`TOKEN`
`static Long`	`TRUSTED`
`static Long`	`UNWRAP`
`static Long`	`UNWRAP_TEMPLATE`
`static Long`	`URL`
`static Long`	`VALUE`
`static Long`	`VALUE_BITS`
`static Long`	`VALUE_LEN`
`static Long`	`VENDOR_DEFINED`
`static Long`	`VERIFY`
`static Long`	`VERIFY_RECOVER`
`static Long`	`WRAP`
`static Long`	`WRAP_TEMPLATE`
`static Long`	`WRAP_WITH_TRUSTED`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Attribute()
Empty constructor.

protected Attribute(Long type)
Constructor taking the PKCS#11 type of the attribute.

Constructors
Modifier	Constructor and Description
`protected`	`Attribute()` Empty constructor.
`protected`	`Attribute(Long type)` Constructor taking the PKCS#11 type of the attribute.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object otherObject)` True, if both attributes are not present or if both attributes are present and all other member variables are equal.
`protected static Class<?>`	`getAttributeClass(Long type)` Get the class of the given attribute type.
`protected static String`	`getAttributeName(Long type)` Get the name of the given attribute type.
`protected sun.security.pkcs11.wrapper.CK_ATTRIBUTE`	`getCkAttribute()` Get the CK_ATTRIBUTE object of this Attribute that contains the attribute type and value .
`protected Long`	`getType()` Get the PKCS#11 type of this attribute.
`protected String`	`getValueString()` Get a string representation of the value of this attribute.
`int`	`hashCode()` The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
`boolean`	`isPresent()` Check, if this attribute is really present in the associated object.
`boolean`	`isSensitive()` Check, if this attribute is sensitive in the associated object.
`protected void`	`setCkAttribute(sun.security.pkcs11.wrapper.CK_ATTRIBUTE ckAttribute)` Set the CK_ATTRIBUTE of this Attribute.
`void`	`setPresent(boolean present)` Set, if this attribute is really present in the associated object.
`void`	`setSensitive(boolean sensitive)` Set, if this attribute is sensitive in the associated object.
`protected void`	`setType(Long type)` Set the PKCS#11 type of this attribute.
`abstract void`	`setValue(Object value)` Redirects the request for setting the attribute value to the implementing attribute class.
`String`	`toString()` Get a string representation of this attribute.
`String`	`toString(boolean withName)` Get a string representation of this attribute.

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

- Field Detail
  - CLASS
```
public static final Long CLASS
```
  - TOKEN
```
public static final Long TOKEN
```
  - PRIVATE
```
public static final Long PRIVATE
```
  - LABEL
```
public static final Long LABEL
```
  - APPLICATION
```
public static final Long APPLICATION
```
  - VALUE
```
public static final Long VALUE
```
  - OBJECT_ID
```
public static final Long OBJECT_ID
```
  - CERTIFICATE_TYPE
```
public static final Long CERTIFICATE_TYPE
```
  - ISSUER
```
public static final Long ISSUER
```
  - SERIAL_NUMBER
```
public static final Long SERIAL_NUMBER
```
  - URL
```
public static final Long URL
```
  - HASH_OF_SUBJECT_PUBLIC_KEY
```
public static final Long HASH_OF_SUBJECT_PUBLIC_KEY
```
  - HASH_OF_ISSUER_PUBLIC_KEY
```
public static final Long HASH_OF_ISSUER_PUBLIC_KEY
```
  - JAVA_MIDP_SECURITY_DOMAIN
```
public static final Long JAVA_MIDP_SECURITY_DOMAIN
```
  - AC_ISSUER
```
public static final Long AC_ISSUER
```
  - OWNER
```
public static final Long OWNER
```
  - ATTR_TYPES
```
public static final Long ATTR_TYPES
```
  - TRUSTED
```
public static final Long TRUSTED
```
  - KEY_TYPE
```
public static final Long KEY_TYPE
```
  - SUBJECT
```
public static final Long SUBJECT
```
  - ID
```
public static final Long ID
```
  - CHECK_VALUE
```
public static final Long CHECK_VALUE
```
  - CERTIFICATE_CATEGORY
```
public static final Long CERTIFICATE_CATEGORY
```
  - SENSITIVE
```
public static final Long SENSITIVE
```
  - ENCRYPT
```
public static final Long ENCRYPT
```
  - DECRYPT
```
public static final Long DECRYPT
```
  - WRAP
```
public static final Long WRAP
```
  - WRAP_TEMPLATE
```
public static final Long WRAP_TEMPLATE
```
  - UNWRAP
```
public static final Long UNWRAP
```
  - UNWRAP_TEMPLATE
```
public static final Long UNWRAP_TEMPLATE
```
  - SIGN
```
public static final Long SIGN
```
  - SIGN_RECOVER
```
public static final Long SIGN_RECOVER
```
  - VERIFY
```
public static final Long VERIFY
```
  - VERIFY_RECOVER
```
public static final Long VERIFY_RECOVER
```
  - DERIVE
```
public static final Long DERIVE
```
  - START_DATE
```
public static final Long START_DATE
```
  - END_DATE
```
public static final Long END_DATE
```
  - MECHANISM_TYPE
```
public static final Long MECHANISM_TYPE
```
  - MODULUS
```
public static final Long MODULUS
```
  - MODULUS_BITS
```
public static final Long MODULUS_BITS
```
  - PUBLIC_EXPONENT
```
public static final Long PUBLIC_EXPONENT
```
  - PRIVATE_EXPONENT
```
public static final Long PRIVATE_EXPONENT
```
  - PRIME_1
```
public static final Long PRIME_1
```
  - PRIME_2
```
public static final Long PRIME_2
```
  - EXPONENT_1
```
public static final Long EXPONENT_1
```
  - EXPONENT_2
```
public static final Long EXPONENT_2
```
  - COEFFICIENT
```
public static final Long COEFFICIENT
```
  - PRIME
```
public static final Long PRIME
```
  - SUBPRIME
```
public static final Long SUBPRIME
```
  - BASE
```
public static final Long BASE
```
  - PRIME_BITS
```
public static final Long PRIME_BITS
```
  - SUB_PRIME_BITS
```
public static final Long SUB_PRIME_BITS
```
  - VALUE_BITS
```
public static final Long VALUE_BITS
```
  - VALUE_LEN
```
public static final Long VALUE_LEN
```
  - EXTRACTABLE
```
public static final Long EXTRACTABLE
```
  - LOCAL
```
public static final Long LOCAL
```
  - NEVER_EXTRACTABLE
```
public static final Long NEVER_EXTRACTABLE
```
  - WRAP_WITH_TRUSTED
```
public static final Long WRAP_WITH_TRUSTED
```
  - ALWAYS_SENSITIVE
```
public static final Long ALWAYS_SENSITIVE
```
  - ALWAYS_AUTHENTICATE
```
public static final Long ALWAYS_AUTHENTICATE
```
  - KEY_GEN_MECHANISM
```
public static final Long KEY_GEN_MECHANISM
```
  - ALLOWED_MECHANISMS
```
public static final Long ALLOWED_MECHANISMS
```
  - MODIFIABLE
```
public static final Long MODIFIABLE
```
  - EC_PARAMS
```
public static final Long EC_PARAMS
```
  - EC_POINT
```
public static final Long EC_POINT
```
  - SECONDARY_AUTH
```
public static final Long SECONDARY_AUTH
```
  - AUTH_PIN_FLAGS
```
public static final Long AUTH_PIN_FLAGS
```
  - HW_FEATURE_TYPE
```
public static final Long HW_FEATURE_TYPE
```
  - RESET_ON_INIT
```
public static final Long RESET_ON_INIT
```
  - HAS_RESET
```
public static final Long HAS_RESET
```
  - VENDOR_DEFINED
```
public static final Long VENDOR_DEFINED
```
  - PIXEL_X
```
public static final Long PIXEL_X
```
  - PIXEL_Y
```
public static final Long PIXEL_Y
```
  - RESOLUTION
```
public static final Long RESOLUTION
```
  - CHAR_ROWS
```
public static final Long CHAR_ROWS
```
  - CHAR_COLUMNS
```
public static final Long CHAR_COLUMNS
```
  - COLOR
```
public static final Long COLOR
```
  - BITS_PER_PIXEL
```
public static final Long BITS_PER_PIXEL
```
  - CHAR_SETS
```
public static final Long CHAR_SETS
```
  - ENCODING_METHODS
```
public static final Long ENCODING_METHODS
```
  - MIME_TYPES
```
public static final Long MIME_TYPES
```
  - attributeNames
```
protected static Hashtable<Long,String> attributeNames
```
  - attributeClasses
```
protected static Hashtable<Long,Class<?>> attributeClasses
```
  - present
```
protected boolean present
```
    True, if the object really possesses this attribute.
  - sensitive
```
protected boolean sensitive
```
    True, if this attribute is sensitive.
  - ckAttribute
```
protected sun.security.pkcs11.wrapper.CK_ATTRIBUTE ckAttribute
```
    The CK_ATTRIBUTE that is used to hold the PKCS#11 type of this attribute and the value.
- Constructor Detail
  - Attribute
```
protected Attribute()
```
    Empty constructor. Attention! If you use this constructor, you must set ckAttribute to ensure that the class invariant is not violated.
  - Attribute
```
protected Attribute(Long type)
```
    Constructor taking the PKCS#11 type of the attribute.
    
    Parameters:
    
    type - The PKCS#11 type of this attribute; e.g. PKCS11Constants.CKA_PRIVATE.
- Method Detail
  - getAttributeName
```
protected static String getAttributeName(Long type)
```
    Get the name of the given attribute type.
    
    Parameters:
    
    type - The attribute type.
    
    Returns:
    
    The name of the attribute type, or null if there is no such type.
  - getAttributeClass
```
protected static Class<?> getAttributeClass(Long type)
```
    Get the class of the given attribute type. Current existing Attribute classes are: AttributeArray BooleanAttribute ByteArrayAttribute CertificateTypeAttribute CharArrayAttribute DateAttribute HardwareFeatureTypeAttribute KeyTypeAttribute LongAttribute MechanismAttribute MechanismArrayAttribute ObjectClassAttribute
    
    Parameters:
    
    type - The attribute type.
    
    Returns:
    
    The class of the attribute type, or null if there is no such type.
  - setPresent
```
public void setPresent(boolean present)
```
    Set, if this attribute is really present in the associated object. Does only make sense if used in combination with template objects.
    
    Parameters:
    
    present - True, if attribute is present.
  - setSensitive
```
public void setSensitive(boolean sensitive)
```
    Set, if this attribute is sensitive in the associated object. Does only make sense if used in combination with template objects.
    
    Parameters:
    
    sensitive - True, if attribute is sensitive.
  - setValue
```
public abstract void setValue(Object value)
```
    Redirects the request for setting the attribute value to the implementing attribute class.
    
    Parameters:
    
    value - the new value
    
    Throws:
    
    ClassCastException - the given value type is not valid for this very Attribute.
    
    UnsupportedOperationException - the OtherAttribute implementation does not support setting a value directly.
  - setCkAttribute
```
protected void setCkAttribute(sun.security.pkcs11.wrapper.CK_ATTRIBUTE ckAttribute)
```
    Set the CK_ATTRIBUTE of this Attribute. Only for internal use.
    
    Parameters:
    
    ckAttribute - The new CK_ATTRIBUTE of this Attribute.
  - isPresent
```
public boolean isPresent()
```
    Check, if this attribute is really present in the associated object.
    
    Returns:
    
    True, if this attribute is really present in the associated object.
  - isSensitive
```
public boolean isSensitive()
```
    Check, if this attribute is sensitive in the associated object.
    
    Returns:
    
    True, if this attribute is sensitive in the associated object.
  - getCkAttribute
```
protected sun.security.pkcs11.wrapper.CK_ATTRIBUTE getCkAttribute()
```
    Get the CK_ATTRIBUTE object of this Attribute that contains the attribute type and value .
    
    Returns:
    
    The CK_ATTRIBUTE of this Attribute.
  - getValueString
```
protected String getValueString()
```
    Get a string representation of the value of this attribute.
    
    Returns:
    
    A string representation of the value of this attribute.
  - toString
```
public String toString()
```
    Get a string representation of this attribute. If the attribute is not present or if it is sensitive, the output of this method shows just a message telling this. This string does not contain the attribute's type name.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value of this attribute.
  - toString
```
public String toString(boolean withName)
```
    Get a string representation of this attribute. If the attribute is not present or if it is sensitive, the output of this method shows just a message telling this.
    
    Parameters:
    
    withName - If true, the string contains the attribute type name and the value. If false, it just contains the value.
    
    Returns:
    
    A string representation of this attribute.
  - setType
```
protected void setType(Long type)
```
    Set the PKCS#11 type of this attribute.
    
    Parameters:
    
    type - The PKCS#11 type of this attribute.
  - getType
```
protected Long getType()
```
    Get the PKCS#11 type of this attribute.
    
    Returns:
    
    The PKCS#11 type of this attribute.
  - equals
```
public boolean equals(Object otherObject)
```
    True, if both attributes are not present or if both attributes are present and all other member variables are equal. False, otherwise.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    otherObject - The other object to compare to.
    
    Returns:
    
    True, if both attributes are not present or if both attributes are present and all other member variables are equal. False, otherwise.
  - hashCode
```
public int hashCode()
```
    The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code of this object.

Class Attribute

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS

TOKEN

PRIVATE

LABEL

APPLICATION

VALUE

OBJECT_ID

CERTIFICATE_TYPE

ISSUER

SERIAL_NUMBER

URL

HASH_OF_SUBJECT_PUBLIC_KEY

HASH_OF_ISSUER_PUBLIC_KEY

JAVA_MIDP_SECURITY_DOMAIN

AC_ISSUER

OWNER

ATTR_TYPES

TRUSTED

KEY_TYPE

SUBJECT

ID

CHECK_VALUE

CERTIFICATE_CATEGORY

SENSITIVE

ENCRYPT

DECRYPT

WRAP

WRAP_TEMPLATE

UNWRAP

UNWRAP_TEMPLATE

SIGN

SIGN_RECOVER

VERIFY

VERIFY_RECOVER

DERIVE

START_DATE

END_DATE

MECHANISM_TYPE

MODULUS

MODULUS_BITS

PUBLIC_EXPONENT

PRIVATE_EXPONENT

PRIME_1

PRIME_2

EXPONENT_1

EXPONENT_2

COEFFICIENT

PRIME

SUBPRIME

BASE

PRIME_BITS

SUB_PRIME_BITS

VALUE_BITS

VALUE_LEN

EXTRACTABLE

LOCAL

NEVER_EXTRACTABLE

WRAP_WITH_TRUSTED

ALWAYS_SENSITIVE

ALWAYS_AUTHENTICATE

KEY_GEN_MECHANISM

ALLOWED_MECHANISMS

MODIFIABLE

EC_PARAMS

EC_POINT

SECONDARY_AUTH

AUTH_PIN_FLAGS

HW_FEATURE_TYPE

RESET_ON_INIT

HAS_RESET

VENDOR_DEFINED

PIXEL_X

PIXEL_Y

RESOLUTION