Class PFX

Represents a PFX structure in a PKCS#12 file.

PFX (Personal Information Exchange) is the main container format for PKCS#12 files. It can store private keys, certificates, and other cryptographic objects in a password-protected format. PKCS#12 files are commonly used for importing and exporting certificates and private keys between applications.

Asn

PFX ::= SEQUENCE {
  version     INTEGER {v3(3)}(v3,...),
  authSafe    ContentInfo,
  macData     MacData OPTIONAL
}

Example

// Load PKCS#12 file from PEM
const p12Pem = '-----BEGIN PKCS12-----...-----END PKCS12-----'
const pfx = PFX.fromPem(p12Pem)

// Extract certificates and private keys
const items = await pfx.extractItems('password123')
const certificate = items.certificates[0]
const privateKey = items.privateKeys[0]

// Create new PKCS#12 file
const newPfx = await PFX.create({
    certificates: [clientCert, caCert],
    privateKeys: [privateKey],
    password: 'newPassword',
    friendlyName: 'My Certificate'
})

// Save as PEM
const pemData = newPfx.toPem()

Hierarchy (View Summary)

PkiBase<PFX>
- PFX

Index

Constructors

constructor

new PFX(
options: { authSafe: ContentInfo; macData?: MacData; version?: number },
): PFX
Creates a new PFX instance.
Parameters
- options: { authSafe: ContentInfo; macData?: MacData; version?: number }
  Configuration object
  - authSafe: ContentInfo
    The authenticated safe content
  - OptionalmacData?: MacData
    Optional MAC data for integrity
  - Optionalversion?: number
    Version number (defaults to 3)
Returns PFX
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:84

Properties

authSafe

authSafe: ContentInfo

The authenticated safe containing the encrypted content.

`Optional`macData

macData?: MacData

Optional MAC data for integrity verification.

version

version: number

Version number (typically 3 for PKCS#12 v1.0).

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

pemHeaders

get pemHeaders(): string
Gets the PEM header name for PKCS#12 files.

Returns string
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:98

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

extractItems

extractItems(
password: string | Uint8Array<ArrayBuffer>,
): Promise<{ certificates: Certificate[]; privateKeys: PrivateKeyInfo[] }>
Parameters
- password: string | Uint8Array<ArrayBuffer>
Returns Promise<{ certificates: Certificate[]; privateKeys: PrivateKeyInfo[] }>
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:213

getBags

getBags(password: string | Uint8Array<ArrayBuffer>): Promise<SafeBag[]>
Parameters
- password: string | Uint8Array<ArrayBuffer>
Returns Promise<SafeBag[]>
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:149

getBagsByName

getBagsByName(
    bagName:
        | "KEY_BAG"
        | "PKCS8_SHROUDED_KEY_BAG"
        | "CERT_BAG"
        | "CRL_BAG"
        | "SECRET_BAG"
        | "SAFE_CONTENTS_BAG",
    password: string | Uint8Array<ArrayBuffer>,
): Promise<SafeBag[]>
Parameters
- bagName:
      | "KEY_BAG"
      | "PKCS8_SHROUDED_KEY_BAG"
      | "CERT_BAG"
      | "CRL_BAG"
      | "SECRET_BAG"
      | "SAFE_CONTENTS_BAG"
- password: string | Uint8Array<ArrayBuffer>
Returns Promise<SafeBag[]>
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:162

getPrivateKeys

getPrivateKeys(
password: string | Uint8Array<ArrayBuffer>,
): Promise<PrivateKeyInfo[]>
Parameters
- password: string | Uint8Array<ArrayBuffer>
Returns Promise<PrivateKeyInfo[]>
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:181

getX509Certificates

getX509Certificates(
password: string | Uint8Array<ArrayBuffer>,
): Promise<Certificate[]>
Parameters
- password: string | Uint8Array<ArrayBuffer>
Returns Promise<Certificate[]>
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:195

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

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

toDer

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

Returns Uint8Array<ArrayBuffer>
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`create

create(
    options: {
        certificates: Certificate[];
        friendlyName?: string;
        password: string | Uint8Array<ArrayBuffer>;
        privateKeys: PrivateKeyInfo[];
    },
): Promise<PFX>
Creates a new PFX instance containing the given certificates and private keys.
Parameters
- options: {
      certificates: Certificate[];
      friendlyName?: string;
      password: string | Uint8Array<ArrayBuffer>;
      privateKeys: PrivateKeyInfo[];
  }
  Configuration object
  - certificates: Certificate[]
    Array of certificates to include
  - OptionalfriendlyName?: string
    Optional friendly name for the key/cert pairs
  - password: string | Uint8Array<ArrayBuffer>
    Password to encrypt the private keys
  - privateKeys: PrivateKeyInfo[]
    Array of private keys to include
Returns Promise<PFX>
A new PFX instance
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:234

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): PFX
Parameters
- asn1: Asn1BaseBlock
Returns PFX
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:118

`Static`fromDer

fromDer(der: Uint8Array<ArrayBuffer>): PFX
Parameters
- der: Uint8Array<ArrayBuffer>
Returns PFX
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:140

`Static`fromPem

fromPem(pem: string): PFX
Parameters
- pem: string
Returns PFX
- Defined in packages/pki-lite/src/pkcs12/PFX.ts:144

Class PFX

Asn

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

authSafe: ContentInfo

OptionalmacData?: MacData

Optionalversion?: number

Returns PFX

Properties

authSafe

OptionalmacData

version

Accessors

pemHeader

Returns string

pemHeaders

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

extractItems

Parameters

Returns Promise<{ certificates: Certificate[]; privateKeys: PrivateKeyInfo[] }>

getBags

Parameters

Returns Promise<SafeBag[]>

getBagsByName

Parameters

Returns Promise<SafeBag[]>

getPrivateKeys

Parameters

Returns Promise<PrivateKeyInfo[]>

getX509Certificates

Parameters

Returns Promise<Certificate[]>

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toDer

Returns Uint8Array<ArrayBuffer>

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

Staticcreate

Parameters

certificates: Certificate[]

OptionalfriendlyName?: string

password: string | Uint8Array<ArrayBuffer>

privateKeys: PrivateKeyInfo[]

Returns Promise<PFX>

StaticfromAsn1

Parameters

Returns PFX

StaticfromDer

Parameters

Returns PFX

StaticfromPem

Parameters

Returns PFX

Settings

On This Page

`Optional`macData?: MacData

`Optional`version?: number

`Optional`macData

`Static`create

`Optional`friendlyName?: string

`Static`fromAsn1

`Static`fromDer

`Static`fromPem