Class CertBag

Represents a CertBag structure in a PKCS#12 file.

A CertBag is used to store certificates within PKCS#12 files. It specifies the certificate type (certId) and contains the certificate data (certValue). The most common certificate type is X.509 certificates, but other formats can also be stored.

Asn

CertBag ::= SEQUENCE {
  certId    BAG-TYPE,
  certValue [0] EXPLICIT ANY DEFINED BY certId
}

Example

// Create a certificate bag for an X.509 certificate
const certBag = new CertBag({
    certId: OIDs.x509Certificate,
    certValue: certificate.toDer()
})

// Extract certificate from bag
if (certBag.certId.is(OIDs.x509Certificate)) {
    const certBytes = certBag.certValue.toAsn1().valueBlock.valueHex
    const certificate = Certificate.fromDer(new Uint8Array(certBytes))
}

// Create from existing certificate
const bagFromCert = CertBag.fromCertificate(certificate)

Hierarchy (View Summary)

PkiBase<CertBag>
- CertBag

Index

Constructors

constructor

new CertBag(
options: { certId: ObjectIdentifierString; certValue: Asn1Any },
): CertBag
Creates a new CertBag instance.
Parameters
- options: { certId: ObjectIdentifierString; certValue: Asn1Any }
  Configuration object
  - certId: ObjectIdentifierString
    Object identifier for the certificate type
  - certValue: Asn1Any
    The certificate data
Returns CertBag
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/pkcs12/CertBag.ts:66

Properties

certId

certId: ObjectIdentifier

Object identifier specifying the certificate type. Common value is OIDs.x509Certificate for X.509 certificates.

certValue

certValue: Any

The certificate data, format determined by certId.

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 this CertBag to its ASN.1 representation.

Returns Asn1BaseBlock
The ASN.1 SEQUENCE structure
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/pkcs12/CertBag.ts:80

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`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): CertBag
Creates a CertBag from an ASN.1 structure.
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 SEQUENCE to parse
Returns CertBag
A new CertBag instance

Throws
Asn1ParseError if the ASN.1 structure is invalid
- Defined in packages/pki-lite/src/pkcs12/CertBag.ts:99

`Static`fromDer

fromDer(der: Uint8Array): CertBag
Parameters
- der: Uint8Array
Returns CertBag
- Defined in packages/pki-lite/src/pkcs12/CertBag.ts:125

Class CertBag

Asn

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

certId: ObjectIdentifierString

certValue: Asn1Any

Returns CertBag

Properties

certId

certValue

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

StaticfromAsn1

Parameters

Returns CertBag

Throws

StaticfromDer

Parameters

Returns CertBag

Settings

On This Page

`Static`fromAsn1

`Static`fromDer