Class Attribute

Represents an attribute structure used in PKCS#7 and PKCS#10.

Asn

Attribute ::= SEQUENCE {
     type OBJECT IDENTIFIER,
     values SET OF AttributeValue
}

AttributeValue ::= ANY

Hierarchy (View Summary)

PkiBase<Attribute>
- Attribute

Constructors

constructor

new Attribute(
options: { type: ObjectIdentifierString; values: Asn1Any[] },
): Attribute
Creates a new attribute.
Parameters
- options: { type: ObjectIdentifierString; values: Asn1Any[] }
Returns Attribute
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/x509/Attribute.ts:44

Properties

type

type: ObjectIdentifier

values

values: Any[]

Accessors

pemHeader

get pemHeader(): string
Gets the PEM header name for this object type. Converts the class name to uppercase for use in PEM encoding.

Returns string
Inherited from PkiBase.pemHeader
- Defined in packages/pki-lite/src/core/PkiBase.ts:60

pkiType

get pkiType(): string
Gets the PKI type name for this object (typically the class name). Used for PEM headers and debugging output.

Returns string
Inherited from PkiBase.pkiType
- Defined in packages/pki-lite/src/core/PkiBase.ts:52

Methods

equals

equals(other: PkiBase<any>): boolean
Compares this PKI object with another for equality. Two objects are considered equal if their DER encodings are identical.
Parameters
- other: PkiBase<any>
  The other PKI object to compare with
Returns boolean
true if the objects are equal, false otherwise
Inherited from PkiBase.equals
- Defined in packages/pki-lite/src/core/PkiBase.ts:122

parseAs

parseAs<T>(type: ParseableAsn1<T>): T
Parses this object as a different PKI type. Useful for converting between related PKI structures.
Type Parameters
- T
  The target type to parse as
Parameters
- type: ParseableAsn1<T>
  The target type constructor with parsing capabilities
Returns T
A new instance of the target type
Inherited from PkiBase.parseAs
- Defined in packages/pki-lite/src/core/PkiBase.ts:134

toAsn1

toAsn1(): Asn1BaseBlock
Converts the attribute to an ASN.1 structure.

Returns Asn1BaseBlock
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/x509/Attribute.ts:56

toDer

toDer(): Uint8Array
Converts this PKI object to DER (Distinguished Encoding Rules) format.

Returns Uint8Array
The DER-encoded bytes of this object
Inherited from PkiBase.toDer
- Defined in packages/pki-lite/src/core/PkiBase.ts:100

toHumanString

toHumanString(): string
Returns a human-readable string representation of this object. By default, returns the same as toString(), but subclasses can override for more user-friendly output.

Returns string
A human-readable string representation
Inherited from PkiBase.toHumanString
- Defined in packages/pki-lite/src/core/PkiBase.ts:90

toJSON

toJSON(): ToJson<T>
Converts this object to a JSON representation.

Returns ToJson<T>
A JSON-serializable representation of this object
Inherited from PkiBase.toJSON
- Defined in packages/pki-lite/src/core/PkiBase.ts:69

toPem

toPem(): string
Converts this PKI object to PEM (Privacy-Enhanced Mail) format.

Returns string
A PEM-encoded string with appropriate headers
Inherited from PkiBase.toPem
- Defined in packages/pki-lite/src/core/PkiBase.ts:109

toString

toString(): string
Returns a string representation of this PKI object. Includes the type name and ASN.1 structure.

Returns string
A string representation for debugging
Inherited from PkiBase.toString
- Defined in packages/pki-lite/src/core/PkiBase.ts:79

`Static`adobeRevocationInfoArchival

adobeRevocationInfoArchival(
revocationInfoArchival: RevocationInfoArchival,
): Attribute
Parameters
- revocationInfoArchival: RevocationInfoArchival
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:194

`Static`commitmentTypeIndication

commitmentTypeIndication(reason: string): Attribute
Parameters
- reason: string
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:171

`Static`contentType

contentType(oid: ObjectIdentifierString | ObjectIdentifier): Attribute
Parameters
- oid: ObjectIdentifierString | ObjectIdentifier
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:123

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): Attribute
Creates an Attribute from an ASN.1 structure.
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 structure
Returns Attribute
The attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:73

`Static`fromDER

fromDER(der: ArrayBuffer | Uint8Array<ArrayBufferLike>): Attribute
Parameters
- der: ArrayBuffer | Uint8Array<ArrayBufferLike>
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:110

`Static`messageDigest

messageDigest(digest: ArrayBuffer | Uint8Array<ArrayBufferLike>): Attribute
Parameters
- digest: ArrayBuffer | Uint8Array<ArrayBufferLike>
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:132

`Static`revocationValues

revocationValues(options: RevocationValues): Attribute
Parameters
- options: RevocationValues
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:187

`Static`signaturePolicyIdentifier

signaturePolicyIdentifier(signaturePolicyId: SignaturePolicyId): Attribute
Parameters
- signaturePolicyId: SignaturePolicyId
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:178

`Static`signingCertificate

signingCertificate(certificate: SigningCertificate): Attribute
Parameters
- certificate: SigningCertificate
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:139

`Static`signingCertificateV2

signingCertificateV2(certificate: SigningCertificateV2): Attribute
Parameters
- certificate: SigningCertificateV2
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:146

`Static`signingLocation

signingLocation(
    options: {
        countryName?: string;
        localityName?: string;
        postalAddress?: string | string[];
    },
): Attribute
Parameters
- options: {
      countryName?: string;
      localityName?: string;
      postalAddress?: string | string[];
  }
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:160

`Static`signingTime

signingTime(date: Date): Attribute
Parameters
- date: Date
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:114

`Static`timestampToken

timestampToken(token: ContentInfo): Attribute
Parameters
- token: ContentInfo
Returns Attribute
- Defined in packages/pki-lite/src/x509/Attribute.ts:153

Class Attribute

Asn

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Attribute

Properties

type

values

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toDer

Returns Uint8Array

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

StaticadobeRevocationInfoArchival

Parameters

Returns Attribute

StaticcommitmentTypeIndication

Parameters

Returns Attribute

StaticcontentType

Parameters

Returns Attribute

StaticfromAsn1

Parameters

Returns Attribute

StaticfromDER

Parameters

Returns Attribute

StaticmessageDigest

Parameters

Returns Attribute

StaticrevocationValues

Parameters

Returns Attribute

StaticsignaturePolicyIdentifier

Parameters

Returns Attribute

StaticsigningCertificate

Parameters

Returns Attribute

StaticsigningCertificateV2

Parameters

Returns Attribute

StaticsigningLocation

Parameters

Returns Attribute

StaticsigningTime

Parameters

Returns Attribute

StatictimestampToken

Parameters

Returns Attribute

Settings

`Static`adobeRevocationInfoArchival

`Static`commitmentTypeIndication

`Static`contentType

`Static`fromAsn1

`Static`fromDER

`Static`messageDigest

`Static`revocationValues

`Static`signaturePolicyIdentifier

`Static`signingCertificate

`Static`signingCertificateV2

`Static`signingLocation

`Static`signingTime

`Static`timestampToken