From fa3dc052de72f837483d8c4b599ba3041e56e302 Mon Sep 17 00:00:00 2001 From: microshine Date: Tue, 21 May 2024 22:37:00 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=2009f86?= =?UTF-8?q?a82b8f8ed24a5e60d322755c00295cfdf47=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/AlgorithmProvider.html | 8 +-- classes/AsnData.html | 14 ++--- classes/AsnDefaultSignatureFormatter.html | 6 +- classes/AsnEcSignatureFormatter.html | 8 +-- classes/Attribute.html | 18 +++--- classes/AttributeFactory.html | 8 +-- classes/AuthorityKeyIdentifierExtension.html | 32 +++++------ classes/BasicConstraintsExtension.html | 24 ++++---- classes/CertificatePolicyExtension.html | 22 ++++---- classes/ChallengePasswordAttribute.html | 18 +++--- classes/CryptoProvider.html | 14 ++--- classes/DefaultAlgorithmSerializer.html | 4 +- classes/EcAlgorithm.html | 8 +-- classes/EdAlgorithm.html | 6 +- classes/ExtendedKeyUsageExtension.html | 22 ++++---- classes/Extension.html | 20 +++---- classes/ExtensionFactory.html | 8 +-- classes/ExtensionsAttribute.html | 18 +++--- classes/GeneralName.html | 16 +++--- classes/GeneralNames.html | 12 ++-- classes/KeyUsagesExtension.html | 22 ++++---- classes/Name.html | 26 ++++----- classes/NameIdentifier.html | 4 +- classes/OidSerializer.html | 4 +- classes/PemConverter.html | 16 +++--- classes/Pkcs10CertificateRequest.html | 42 +++++++------- .../Pkcs10CertificateRequestGenerator.html | 4 +- classes/PublicKey.html | 28 +++++----- classes/RsaAlgorithm.html | 6 +- classes/ShaAlgorithm.html | 6 +- classes/SubjectAlternativeNameExtension.html | 20 +++---- classes/SubjectKeyIdentifierExtension.html | 24 ++++---- classes/TextConverter.html | 4 +- classes/TextObject.html | 4 +- classes/X509Certificate.html | 56 +++++++++---------- classes/X509CertificateGenerator.html | 6 +- classes/X509Certificates.html | 24 ++++---- classes/X509ChainBuilder.html | 4 +- classes/X509Crl.html | 56 +++++++++---------- classes/X509CrlEntry.html | 24 ++++---- classes/X509CrlGenerator.html | 4 +- enums/ExtendedKeyUsage.html | 4 +- enums/KeyUsageFlags.html | 4 +- enums/X509CrlReason.html | 4 +- interfaces/AlgorithmSerializer.html | 4 +- interfaces/CertificateIdentifier.html | 6 +- interfaces/HashedAlgorithm.html | 4 +- interfaces/IAlgorithm.html | 6 +- interfaces/IAsnSignatureFormatter.html | 6 +- interfaces/IPublicKeyContainer.html | 4 +- interfaces/IdOrName.html | 2 +- interfaces/JsonAttributeAndObjectValue.html | 2 +- interfaces/JsonAttributeAndStringValue.html | 2 +- interfaces/JsonAttributeObject.html | 4 +- interfaces/JsonGeneralName.html | 4 +- interfaces/PemHeader.html | 4 +- interfaces/PemStruct.html | 8 +-- .../Pkcs10CertificateRequestCreateParams.html | 12 ++-- interfaces/TextObjectConvertible.html | 4 +- interfaces/UnknownAlgorithm.html | 4 +- .../X509CertificateCreateCommonParams.html | 12 ++-- .../X509CertificateCreateParamsBase.html | 12 ++-- ...X509CertificateCreateSelfSignedParams.html | 12 ++-- .../X509CertificateCreateWithKeyParams.html | 12 ++-- ...9CertificateCreateWithSignatureParams.html | 16 +++--- interfaces/X509CertificateVerifyParams.html | 4 +- interfaces/X509ChainBuilderParams.html | 4 +- interfaces/X509CrlCreateParams.html | 6 +- interfaces/X509CrlCreateParamsBase.html | 6 +- interfaces/X509CrlEntryParams.html | 6 +- interfaces/X509CrlVerifyParams.html | 4 +- types/AsnDataStringFormat.html | 2 +- types/ExtendedKeyUsageType.html | 2 +- types/GeneralNameType.html | 2 +- types/JsonAttributeAndValue.html | 2 +- types/JsonGeneralNames.html | 2 +- types/JsonName.html | 2 +- types/JsonNameParams.html | 2 +- types/MapForEachCallback.html | 2 +- types/PemStructEncodeParams.html | 2 +- ...s10CertificateRequestCreateParamsName.html | 2 +- types/PublicKeyType.html | 2 +- types/TextObjectItemType.html | 2 +- types/X509CertificateCreateParams.html | 2 +- types/X509CertificateCreateParamsName.html | 2 +- types/X509CertificatesExportType.html | 2 +- variables/cryptoProvider-1.html | 2 +- variables/diAlgorithm.html | 2 +- variables/diAlgorithmProvider.html | 2 +- variables/diAsnSignatureFormatter.html | 2 +- variables/idEd25519.html | 2 +- variables/idEd448.html | 2 +- variables/idX25519.html | 2 +- variables/idX448.html | 2 +- 94 files changed, 449 insertions(+), 449 deletions(-) diff --git a/classes/AlgorithmProvider.html b/classes/AlgorithmProvider.html index af25c7a0..fc942702 100644 --- a/classes/AlgorithmProvider.html +++ b/classes/AlgorithmProvider.html @@ -1,13 +1,13 @@ -AlgorithmProvider | @peculiar/x509

Class AlgorithmProvider

Constructors

constructor +AlgorithmProvider | @peculiar/x509

Class AlgorithmProvider

Constructors

Methods

  • Converts WebCrypto algorithm to ASN.1 algorithm

    Parameters

    • alg: Algorithm

      WebCrypto algorithm

    Returns AlgorithmIdentifier

    ASN.1 algorithm

    Throws

    Error whenever cannot convert an algorithm

    -
  • ConvertsASN.1 algorithm to WebCrypto algorithm

    +
  • ConvertsASN.1 algorithm to WebCrypto algorithm

    Parameters

    • alg: AlgorithmIdentifier

      ASN.1 algorithm

    Returns Algorithm

    algorithm

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/classes/AsnData.html b/classes/AsnData.html index 3c4e587f..e5cdd7ef 100644 --- a/classes/AsnData.html +++ b/classes/AsnData.html @@ -1,5 +1,5 @@ AsnData | @peculiar/x509

Class AsnData<T>Abstract

Represents an ASN.1 data

-

Type Parameters

  • T

Hierarchy (view full)

Implements

Constructors

Type Parameters

  • T

Hierarchy (view full)

Implements

Constructors

Properties

Methods

equal @@ -11,11 +11,11 @@

Constructors

  • Creates a new instance

    Type Parameters

    • T

    Parameters

    • raw: BufferSource

      DER encoded buffer

    • type: (new () => T)

      ASN.1 convertible class for @peculiar/asn1-schema schema

      -
        • new (): T
        • Returns T

    Returns AsnData<T>

  • ASN.1 object

    -

    Type Parameters

    • T

    Parameters

    • asn: T

    Returns AsnData<T>

Properties

rawData: ArrayBuffer

Gets a DER encoded buffer

-
NAME: string = "ASN"

Methods

  • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

    +
      • new (): T
      • Returns T

Returns AsnData<T>

  • ASN.1 object

    +

    Type Parameters

    • T

    Parameters

    • asn: T

    Returns AsnData<T>

  • Properties

    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    NAME: string = "ASN"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      Parameters

      • data: any

        Any data

        -

      Returns data is AsnData<T>

    • Occurs on instance initialization

      +

    Returns data is AsnData<T>

    • Occurs on instance initialization

      Parameters

      • asn: T

        ASN.1 object

        -

      Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/AsnDefaultSignatureFormatter.html b/classes/AsnDefaultSignatureFormatter.html index ce694537..8609a839 100644 --- a/classes/AsnDefaultSignatureFormatter.html +++ b/classes/AsnDefaultSignatureFormatter.html @@ -2,11 +2,11 @@

    To register it's implementation in global use tsyringe container

    Example

    import { container } from "tsyringe";

    container.registerSingleton(diAsnSignatureFormatter, AsnDefaultSignatureFormatter);
    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    \ No newline at end of file +

    Returns null | ArrayBuffer

    \ No newline at end of file diff --git a/classes/AsnEcSignatureFormatter.html b/classes/AsnEcSignatureFormatter.html index eca054fe..940d5e65 100644 --- a/classes/AsnEcSignatureFormatter.html +++ b/classes/AsnEcSignatureFormatter.html @@ -2,15 +2,15 @@

    To register it's implementation in global use tsyringe container

    Example

    import { container } from "tsyringe";

    container.registerSingleton(diAsnSignatureFormatter, AsnDefaultSignatureFormatter);
    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    defaultNamedCurveSize: number = 32
    namedCurveSize: Map<string, number> = ...

    Methods

    • Parameters

      • data: BufferSource
      • positive: boolean = false

      Returns ArrayBufferLike

    • Converts ASN.1 signature to WebCrypto format

      +

    Constructors

    Properties

    defaultNamedCurveSize: number = 32
    namedCurveSize: Map<string, number> = ...

    Methods

    • Parameters

      • data: BufferSource
      • positive: boolean = false

      Returns ArrayBufferLike

    • Converts ASN.1 signature to WebCrypto format

      Parameters

      • algorithm: Algorithm

        Key and signing algorithm

      • signature: BufferSource

        ASN.1 signature value in DER format

        -

      Returns null | ArrayBuffer

    \ No newline at end of file +

    Returns null | ArrayBuffer

    \ No newline at end of file diff --git a/classes/Attribute.html b/classes/Attribute.html index a50ee19b..6aee4fc3 100644 --- a/classes/Attribute.html +++ b/classes/Attribute.html @@ -1,5 +1,5 @@ Attribute | @peculiar/x509

    Represents the Attribute structure

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    rawData type values @@ -14,14 +14,14 @@

    Constructors

    • Crates a new instance

      Parameters

      • type: string

        Attribute identifier

      • Optional values: BufferSource[]

        List of DER encoded attribute values

        -

      Returns Attribute

    • Crates a new instance from DER encoded buffer

      +

    Returns Attribute

  • Crates a new instance from DER encoded buffer

    Parameters

    • raw: BufferSource

      DER encoded buffer

      -

    Returns Attribute

  • Properties

    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an attribute identifier

    -
    values: ArrayBuffer[]

    Gets a list of DER encoded attribute values

    -
    NAME: string = "Attribute"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns Attribute

    Properties

    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an attribute identifier

    +
    values: ArrayBuffer[]

    Gets a list of DER encoded attribute values

    +
    NAME: string = "Attribute"

    Methods

    • Occurs on instance initialization

      +

    Returns data is Attribute

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/AttributeFactory.html b/classes/AttributeFactory.html index 9794a29d..97fc6634 100644 --- a/classes/AttributeFactory.html +++ b/classes/AttributeFactory.html @@ -1,15 +1,15 @@ AttributeFactory | @peculiar/x509

    Class AttributeFactory

    Static class to manage X509 attributes

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    items: Map<string, typeof Attribute> = ...

    Methods

    • Returns X509 Attribute based on it's identifier

      +

    Constructors

    Properties

    items: Map<string, typeof Attribute> = ...

    Methods

    • Registers a new X509 Attribute class. If id already exists replaces it

      Parameters

      • id: string

        Attribute identifier

      • type: any

        Attribute class

      Returns void

      Example

      AttributeFactory.register(asnPkcs9.id_pkcs9_at_challengePassword, ChallengePasswordAttribute);
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/AuthorityKeyIdentifierExtension.html b/classes/AuthorityKeyIdentifierExtension.html index bcde100b..2d9a2615 100644 --- a/classes/AuthorityKeyIdentifierExtension.html +++ b/classes/AuthorityKeyIdentifierExtension.html @@ -1,5 +1,5 @@ AuthorityKeyIdentifierExtension | @peculiar/x509

    Class AuthorityKeyIdentifierExtension

    Represents the Authority Key Identifier certificate extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    certId? critical keyId? @@ -17,33 +17,33 @@ create

    Constructors

    Returns AuthorityKeyIdentifierExtension

  • Creates a new instance

    Parameters

    • identifier: string

      Hexadecimal representation of key identifier

    • Optional critical: boolean

      Indicates where extension is critical. Default is false

      -

    Returns AuthorityKeyIdentifierExtension

  • Creates a new instance

    +
  • Returns AuthorityKeyIdentifierExtension

  • Creates a new instance

    Parameters

    • id: CertificateIdentifier

      Certificate identifier in the issuer name and serial number

    • Optional critical: boolean

      Indicates where extension is critical. Default is false

      -

    Returns AuthorityKeyIdentifierExtension

  • Properties

    Gets a certificate identifier in the issuer name and serial number

    -
    critical: boolean

    Indicates where extension is critical

    -
    keyId?: string

    Gets a hexadecimal representation of key identifier

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "Authority Key Identifier"

    Methods

    Returns AuthorityKeyIdentifierExtension

    Properties

    Gets a certificate identifier in the issuer name and serial number

    +
    critical: boolean

    Indicates where extension is critical

    +
    keyId?: string

    Gets a hexadecimal representation of key identifier

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "Authority Key Identifier"

    Methods

    • Occurs on instance initialization

      +

    Returns data is AuthorityKeyIdentifierExtension

    Returns void

    Returns Promise<AuthorityKeyIdentifierExtension>

  • Creates authority key identifier extension from certificate identifier

    Parameters

    • certId: CertificateIdentifier

      Certificate identifier

    • Optional critical: boolean

      Indicates where extension is critical. Default is false

    • Optional crypto: Crypto

      WebCrypto provider. Default is from CryptoProvider

      -

    Returns Promise<AuthorityKeyIdentifierExtension>

  • Creates authority key identifier extension from CryptoKey

    +
  • Returns Promise<AuthorityKeyIdentifierExtension>

  • Creates authority key identifier extension from CryptoKey

    Parameters

    • publicKey: CryptoKey

      Public CryptoKey

    • Optional critical: boolean

      Indicates where extension is critical. Default is false

    • Optional crypto: Crypto

      WebCrypto provider. Default is from CryptoProvider

      -

    Returns Promise<AuthorityKeyIdentifierExtension>

  • \ No newline at end of file +

    Returns Promise<AuthorityKeyIdentifierExtension>

    \ No newline at end of file diff --git a/classes/BasicConstraintsExtension.html b/classes/BasicConstraintsExtension.html index 3fbaac2d..fcd3074f 100644 --- a/classes/BasicConstraintsExtension.html +++ b/classes/BasicConstraintsExtension.html @@ -1,5 +1,5 @@ BasicConstraintsExtension | @peculiar/x509

    Class BasicConstraintsExtension

    Represents the Basic Constraints certificate extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    ca: boolean

    Indicates whether the certified public key may be used +

    Returns BasicConstraintsExtension

  • Creates a new instance

    +

    Parameters

    • ca: boolean
    • Optional pathLength: number
    • Optional critical: boolean

    Returns BasicConstraintsExtension

  • Properties

    ca: boolean

    Indicates whether the certified public key may be used to verify certificate signatures

    -
    critical: boolean

    Indicates where extension is critical

    -
    pathLength?: number

    Gets a maximum number of non-self-issued intermediate certificates that may +

    critical: boolean

    Indicates where extension is critical

    +
    pathLength?: number

    Gets a maximum number of non-self-issued intermediate certificates that may follow this certificate in a valid certification path

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "Basic Constraints"

    Methods

    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "Basic Constraints"

    Methods

    • Occurs on instance initialization

      +

    Returns data is BasicConstraintsExtension

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/CertificatePolicyExtension.html b/classes/CertificatePolicyExtension.html index 82b45caf..c1f895bd 100644 --- a/classes/CertificatePolicyExtension.html +++ b/classes/CertificatePolicyExtension.html @@ -1,5 +1,5 @@ CertificatePolicyExtension | @peculiar/x509

    Class CertificatePolicyExtension

    Represents the Certificate Policy extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    critical: boolean

    Indicates where extension is critical

    -
    policies: readonly string[]

    Gets the list of certificate policies

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "Certificate Policies"

    Methods

    Returns CertificatePolicyExtension

  • Creates a new instance

    +

    Parameters

    • policies: string[]
    • Optional critical: boolean

    Returns CertificatePolicyExtension

  • Properties

    critical: boolean

    Indicates where extension is critical

    +
    policies: readonly string[]

    Gets the list of certificate policies

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "Certificate Policies"

    Methods

    • Occurs on instance initialization

      +

    Returns data is CertificatePolicyExtension

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/ChallengePasswordAttribute.html b/classes/ChallengePasswordAttribute.html index d2e8c781..a98ccaa2 100644 --- a/classes/ChallengePasswordAttribute.html +++ b/classes/ChallengePasswordAttribute.html @@ -1,5 +1,5 @@ ChallengePasswordAttribute | @peculiar/x509

    Class ChallengePasswordAttribute

    Represents the Attribute structure

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    password: string
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an attribute identifier

    -
    values: ArrayBuffer[]

    Gets a list of DER encoded attribute values

    -
    NAME: string = "Challenge Password"

    Methods

    Returns ChallengePasswordAttribute

  • Creates a new instance

    +

    Parameters

    • value: string

    Returns ChallengePasswordAttribute

  • Properties

    password: string
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an attribute identifier

    +
    values: ArrayBuffer[]

    Gets a list of DER encoded attribute values

    +
    NAME: string = "Challenge Password"

    Methods

    • Occurs on instance initialization

      +

    Returns data is ChallengePasswordAttribute

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/CryptoProvider.html b/classes/CryptoProvider.html index 4d284dcc..93332e01 100644 --- a/classes/CryptoProvider.html +++ b/classes/CryptoProvider.html @@ -1,5 +1,5 @@ CryptoProvider | @peculiar/x509

    Class CryptoProvider

    Crypto provider

    -

    Implements

    • Map<string, Crypto>

    Constructors

    Implements

    • Map<string, Crypto>

    Constructors

    Properties

    Constructors

    Properties

    [toStringTag]: string = "CryptoProvider"
    items: Map<string, Crypto> = ...
    DEFAULT: string = "default"

    Accessors

    Methods

    • Returns IterableIterator<[string, Crypto]>

    • Parameters

      • key: string

      Returns boolean

    • Returns IterableIterator<[string, Crypto]>

    Properties

    [toStringTag]: string = "CryptoProvider"
    items: Map<string, Crypto> = ...
    DEFAULT: string = "default"

    Accessors

    Methods

    • Returns IterableIterator<[string, Crypto]>

    • Parameters

      • key: string

      Returns boolean

    • Returns IterableIterator<[string, Crypto]>

    • Returns default crypto

      Returns Crypto

      Throws

      Error whenever default provider not set

      -
    • Returns crypto by name

      +
    • Returns crypto by name

      Parameters

      • key: string

        Crypto name

      Returns Crypto

      Throws

      Error whenever provider with specified identifier does not exist

      -
    • Parameters

      • key: string

      Returns boolean

    • Returns IterableIterator<string>

    • Sets default crypto

      -

      Parameters

      • value: Crypto

      Returns this

    • Sets crypto with specified identifier

      +
    • Parameters

      • key: string

      Returns boolean

    • Returns IterableIterator<string>

    • Sets default crypto

      +

      Parameters

      • value: Crypto

      Returns this

    • Sets crypto with specified identifier

      Parameters

      • key: string

        Identifier

      • value: Crypto

        crypto provider

        -

      Returns this

    • Returns IterableIterator<Crypto>

    • Parameters

      • data: any

      Returns data is CryptoKey

    • Returns true if data is CryptoKeyPair

      -

      Parameters

      • data: any

      Returns data is CryptoKeyPair

    \ No newline at end of file +

    Returns this

    \ No newline at end of file diff --git a/classes/DefaultAlgorithmSerializer.html b/classes/DefaultAlgorithmSerializer.html index 10080685..150595bb 100644 --- a/classes/DefaultAlgorithmSerializer.html +++ b/classes/DefaultAlgorithmSerializer.html @@ -1,3 +1,3 @@ -DefaultAlgorithmSerializer | @peculiar/x509

    Class DefaultAlgorithmSerializerAbstract

    Constructors

    constructor +DefaultAlgorithmSerializer | @peculiar/x509

    Class DefaultAlgorithmSerializerAbstract

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file diff --git a/classes/EcAlgorithm.html b/classes/EcAlgorithm.html index 69d53c1a..f774aedb 100644 --- a/classes/EcAlgorithm.html +++ b/classes/EcAlgorithm.html @@ -1,12 +1,12 @@ EcAlgorithm | @peculiar/x509

    Class EcAlgorithm

    EC algorithm provider

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    SECP256K1: string = "1.3.132.0.10"

    Methods

    • Converts WebCrypto algorithm to ASN.1 algorithm

      +

    Constructors

    Properties

    SECP256K1: string = "1.3.132.0.10"

    Methods

    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/EdAlgorithm.html b/classes/EdAlgorithm.html index 0d5bd11f..db7a5854 100644 --- a/classes/EdAlgorithm.html +++ b/classes/EdAlgorithm.html @@ -1,11 +1,11 @@ EdAlgorithm | @peculiar/x509

    Class EdAlgorithm

    ECDH-ES and EdDSA algorithm provider

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Converts WebCrypto algorithm to ASN.1 algorithm

      Parameters

      • alg: EcKeyGenParams

        WebCrypto algorithm

      Returns null | AlgorithmIdentifier

      ASN.1 algorithm or null

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/ExtendedKeyUsageExtension.html b/classes/ExtendedKeyUsageExtension.html index 8f9be2c7..1faf3b71 100644 --- a/classes/ExtendedKeyUsageExtension.html +++ b/classes/ExtendedKeyUsageExtension.html @@ -1,5 +1,5 @@ ExtendedKeyUsageExtension | @peculiar/x509

    Class ExtendedKeyUsageExtension

    Represents the Extended Key Usage certificate extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    critical: boolean

    Indicates where extension is critical

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -

    Gets a list of purposes for which the certified public key may be used

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "Extended Key Usages"

    Methods

    Returns ExtendedKeyUsageExtension

  • Creates a new instance

    +

    Parameters

    Returns ExtendedKeyUsageExtension

  • Properties

    critical: boolean

    Indicates where extension is critical

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +

    Gets a list of purposes for which the certified public key may be used

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "Extended Key Usages"

    Methods

    • Occurs on instance initialization

      +

    Returns data is ExtendedKeyUsageExtension

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/Extension.html b/classes/Extension.html index 426e180e..cd9de114 100644 --- a/classes/Extension.html +++ b/classes/Extension.html @@ -1,5 +1,5 @@ Extension | @peculiar/x509

    Represents the certificate extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Returns Extension

  • Creates a new instance

    Parameters

    • type: string

      Extension identifier

    • critical: boolean

      Indicates where extension is critical

    • value: BufferSource

      DER encoded value of extension

      -

    Returns Extension

  • Properties

    critical: boolean

    Indicates where extension is critical

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "ASN"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns Extension

    Properties

    critical: boolean

    Indicates where extension is critical

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "ASN"

    Methods

    • Occurs on instance initialization

      +

    Returns data is Extension

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/ExtensionFactory.html b/classes/ExtensionFactory.html index 7ae83403..77dbe259 100644 --- a/classes/ExtensionFactory.html +++ b/classes/ExtensionFactory.html @@ -1,15 +1,15 @@ ExtensionFactory | @peculiar/x509

    Class ExtensionFactory

    Static class to manage X509 extensions

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    items: Map<string, typeof Extension> = ...

    Methods

    • Returns X509 Extension based on it's identifier

      +

    Constructors

    Properties

    items: Map<string, typeof Extension> = ...

    Methods

    • Registers a new X509 Extension class. If id already exists replaces it

      Parameters

      • id: string

        Extension identifier

      • type: any

        Extension class

      Returns void

      Example

      ExtensionFactory.register(asnX509.id_ce_basicConstraints, extensions.BasicConstraintsExtension);
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/ExtensionsAttribute.html b/classes/ExtensionsAttribute.html index 2277fc58..6125d3ea 100644 --- a/classes/ExtensionsAttribute.html +++ b/classes/ExtensionsAttribute.html @@ -1,5 +1,5 @@ ExtensionsAttribute | @peculiar/x509

    Class ExtensionsAttribute

    Represents the Attribute structure

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    items: Extension[]
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an attribute identifier

    -
    values: ArrayBuffer[]

    Gets a list of DER encoded attribute values

    -
    NAME: string = "Extensions"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns ExtensionsAttribute

  • Creates a new instance

    +

    Parameters

    Returns ExtensionsAttribute

  • Properties

    items: Extension[]
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an attribute identifier

    +
    values: ArrayBuffer[]

    Gets a list of DER encoded attribute values

    +
    NAME: string = "Extensions"

    Methods

    • Occurs on instance initialization

      +

    Returns data is ExtensionsAttribute

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/GeneralName.html b/classes/GeneralName.html index 8f18f701..75731075 100644 --- a/classes/GeneralName.html +++ b/classes/GeneralName.html @@ -1,6 +1,6 @@ GeneralName | @peculiar/x509

    Class GeneralName

    Represents ASN.1 type of GeneralName.

    This class doesn't support no standard string format is defined for otherName, X.400 name, EDI party name, or any other type of names.

    -

    Hierarchy (view full)

    • AsnData<asn1X509.GeneralName>
      • GeneralName

    Constructors

    Hierarchy (view full)

    • AsnData<asn1X509.GeneralName>
      • GeneralName

    Constructors

    Properties

    Constructors

    Properties

    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -

    Type of the storing value

    -
    value: string

    Text representation of ASN.1 GeneralName

    -
    NAME: string = "ASN"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Constructors

    Properties

    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +

    Type of the storing value

    +
    value: string

    Text representation of ASN.1 GeneralName

    +
    NAME: string = "ASN"

    Methods

    • Occurs on instance initialization

      +

    Returns data is GeneralName

    • Occurs on instance initialization

      Parameters

      • asn: GeneralName

      Returns void

      Throws

      Throws error if ASN.1 GeneralName contains unsupported value (eg otherName, X400 address, EDI party name)

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/GeneralNames.html b/classes/GeneralNames.html index 87328470..757f5a8b 100644 --- a/classes/GeneralNames.html +++ b/classes/GeneralNames.html @@ -1,5 +1,5 @@ GeneralNames | @peculiar/x509

    Class GeneralNames

    Represents an ASN.1 data

    -

    Hierarchy (view full)

    • AsnData<asn1X509.GeneralNames>
      • GeneralNames

    Constructors

    Hierarchy (view full)

    • AsnData<asn1X509.GeneralNames>
      • GeneralNames

    Constructors

    Properties

    Constructors

    Properties

    items: readonly GeneralName[]
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    NAME: string = "GeneralNames"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Constructors

    Properties

    items: readonly GeneralName[]
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    NAME: string = "GeneralNames"

    Methods

    • Occurs on instance initialization

      +

    Returns data is GeneralNames

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/KeyUsagesExtension.html b/classes/KeyUsagesExtension.html index 135a6aea..d384110d 100644 --- a/classes/KeyUsagesExtension.html +++ b/classes/KeyUsagesExtension.html @@ -1,5 +1,5 @@ KeyUsagesExtension | @peculiar/x509

    Class KeyUsagesExtension

    Represents the Key Usage certificate extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    critical: boolean

    Indicates where extension is critical

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -

    Gets a key usages flag

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "Key Usages"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns KeyUsagesExtension

  • Creates a new instance

    +

    Parameters

    Returns KeyUsagesExtension

  • Properties

    critical: boolean

    Indicates where extension is critical

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +

    Gets a key usages flag

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "Key Usages"

    Methods

    • Occurs on instance initialization

      +

    Returns data is KeyUsagesExtension

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/Name.html b/classes/Name.html index 1f479b9a..1abb1524 100644 --- a/classes/Name.html +++ b/classes/Name.html @@ -1,6 +1,6 @@ Name | @peculiar/x509

    UTF-8 String Representation of Distinguished Names

    https://tools.ietf.org/html/rfc2253

    -

    Constructors

    Constructors

    Properties

    Methods

    fromJSON @@ -17,24 +17,24 @@

    Parameters

    • data: string | BufferSource | JsonNameParams | Name
    • extraNames: IdOrName = {}

      Extra identifiers for name customization

    Returns Name

    Example

    const text = "URL=http://some.url.com, IP=192.168.0.1, GUID={8ee13e53-2c1c-42bb-8df7-39927c0bdbb6}";
    const name = new x509.Name(text, {
    "Email": "1.2.3.4.5.1",
    "IP": "1.2.3.4.5.2",
    "GUID": "1.2.3.4.5.3",
    });
    -

    Properties

    asn: Name = ...

    ASN.1 Name

    -
    extraNames: NameIdentifier = ...

    Methods

    • Creates AsnName object from string

      -

      Parameters

      • data: string

      Returns Name

    • Returns a list of string values filtered by specified id or name

      +

    Properties

    asn: Name = ...

    ASN.1 Name

    +
    extraNames: NameIdentifier = ...

    Methods

    • Creates AsnName object from string

      +

      Parameters

      • data: string

      Returns Name

    • Returns a list of string values filtered by specified id or name

      Parameters

      • idOrName: string

        ObjectIdentifier or string name

      Returns string[]

      Returns a list of strings. Returns an empty list if there are not any values for specified id/name.

      -
    • Parameters

      • idOrName: string

      Returns null | string

    • Returns a SHA-1 thumbprint

      +
    • Parameters

      • idOrName: string

      Returns null | string

    • Returns a SHA-1 thumbprint

      Parameters

      • Optional crypto: Crypto

        Crypto provider. Default is from CryptoProvider

        -

      Returns Promise<ArrayBuffer>

    • Returns a thumbprint for specified mechanism

      +

    Returns Promise<ArrayBuffer>

  • Returns a thumbprint for specified mechanism

    Parameters

    • algorithm: AlgorithmIdentifier

      Hash algorithm

    • Optional crypto: Crypto

      Crypto provider. Default is from CryptoProvider

      -

    Returns Promise<ArrayBuffer>

    • Returns Name in DER encoded format

      -

      Returns ArrayBuffer

    • Returns string serialized Name

      -

      Returns string

    • Returns true if text is ASCII otherwise false

      +

    Returns Promise<ArrayBuffer>

    • Returns Name in DER encoded format

      +

      Returns ArrayBuffer

    • Returns string serialized Name

      +

      Returns string

    • Returns true if text is ASCII otherwise false

      Parameters

      • text: string

        Text

        -

      Returns boolean

    • Checks if a given string is a printable string. +

    Returns boolean

    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/NameIdentifier.html b/classes/NameIdentifier.html index 1571675d..47d0bf31 100644 --- a/classes/NameIdentifier.html +++ b/classes/NameIdentifier.html @@ -1,6 +1,6 @@ -NameIdentifier | @peculiar/x509

    Class NameIdentifier

    Constructors

    constructor +NameIdentifier | @peculiar/x509

    Class NameIdentifier

    Constructors

    Properties

    Methods

    Constructors

    Properties

    items: IdOrName = {}

    Methods

    • Parameters

      • idOrName: string

      Returns null | string

    • Parameters

      • idOrName: string

      Returns null | string

    • Parameters

      • id: string
      • name: string

      Returns void

    \ No newline at end of file +

    Constructors

    Properties

    items: IdOrName = {}

    Methods

    • Parameters

      • idOrName: string

      Returns null | string

    • Parameters

      • idOrName: string

      Returns null | string

    • Parameters

      • id: string
      • name: string

      Returns void

    \ No newline at end of file diff --git a/classes/OidSerializer.html b/classes/OidSerializer.html index 73683278..fc55dad3 100644 --- a/classes/OidSerializer.html +++ b/classes/OidSerializer.html @@ -1,4 +1,4 @@ -OidSerializer | @peculiar/x509

    Class OidSerializerAbstract

    Constructors

    constructor +OidSerializer | @peculiar/x509

    Class OidSerializerAbstract

    Constructors

    Properties

    Methods

    Constructors

    Properties

    items: Record<string, string> = ...

    Methods

    \ No newline at end of file +

    Constructors

    Properties

    items: Record<string, string> = ...

    Methods

    \ No newline at end of file diff --git a/classes/PemConverter.html b/classes/PemConverter.html index 0ad1435a..433d2d2e 100644 --- a/classes/PemConverter.html +++ b/classes/PemConverter.html @@ -1,5 +1,5 @@ PemConverter | @peculiar/x509

    Class PemConverter

    Represents PEM Converter.

    -

    Constructors

    Constructors

    Properties

    Constructors

    Properties

    CertificateRequestTag: string = "CERTIFICATE REQUEST"
    CertificateTag: string = "CERTIFICATE"
    CrlTag: string = "CRL"
    PrivateKeyTag: string = "PRIVATE KEY"
    PublicKeyTag: string = "PUBLIC KEY"

    Methods

    • Decodes PEM to a list of raws

      +

    Constructors

    Properties

    CertificateRequestTag: string = "CERTIFICATE REQUEST"
    CertificateTag: string = "CERTIFICATE"
    CrlTag: string = "CRL"
    PrivateKeyTag: string = "PRIVATE KEY"
    PublicKeyTag: string = "PUBLIC KEY"

    Methods

    • Decodes PEM to a list of raws

      Parameters

      • pem: string

        message in PEM format

        -

      Returns ArrayBuffer[]

    • Decodes PEM and returns first item from the list

      +

    Returns ArrayBuffer[]

    • Decodes PEM and returns first item from the list

      Parameters

      • pem: string

        message in PEM format

      Returns ArrayBuffer

      Throw

      Throws RangeError if list of decoded items is empty

      -
    • Encodes a list of PemStruct in PEM format

      Parameters

      Returns string

    • Encodes a raw data in PEM format

      +

    Returns string

  • Encodes a raw data in PEM format

    Parameters

    • rawData: BufferSource

      Raw data

    • tag: string

      PEM tag

      -

    Returns string

  • Encodes a list of raws in PEM format

    +
  • Returns string

  • Encodes a list of raws in PEM format

    Parameters

    • rawData: BufferSource[]
    • tag: string

      PEM tag

      -

    Returns string

  • Returns string

    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/Pkcs10CertificateRequest.html b/classes/Pkcs10CertificateRequest.html index 19e6779d..a222f110 100644 --- a/classes/Pkcs10CertificateRequest.html +++ b/classes/Pkcs10CertificateRequest.html @@ -1,5 +1,5 @@ Pkcs10CertificateRequest | @peculiar/x509

    Class Pkcs10CertificateRequest

    Representation of PKCS10 Certificate Request

    -

    Hierarchy

    • PemData<CertificationRequest>
      • Pkcs10CertificateRequest

    Implements

    Constructors

    Hierarchy

    • PemData<CertificationRequest>
      • Pkcs10CertificateRequest

    Implements

    Constructors

    Properties

    Constructors

    Returns Pkcs10CertificateRequest

  • Creates a new instance from ASN.1 CertificationRequest

    Parameters

    • asn: CertificationRequest

      ASN.1 CertificationRequest

      -

    Returns Pkcs10CertificateRequest

  • Properties

    attributes: Attribute[]

    Gets a list fo CSR attributes

    -
    extensions: Extension[]

    Gets a list of CSR extensions

    -
    publicKey: PublicKey

    Gets a public key of CSR

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    signature: ArrayBuffer

    Gets a signature

    -
    signatureAlgorithm: HashedAlgorithm

    Gets a signature algorithm

    -
    subject: string

    Gets a string subject name

    -
    subjectName: Name

    Gets the subject value from the certificate as an Name

    -
    tag: string
    tbs: ArrayBuffer

    ToBeSigned block of CSR

    -
    NAME: string = "PKCS#10 Certificate Request"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns Pkcs10CertificateRequest

    Properties

    attributes: Attribute[]

    Gets a list fo CSR attributes

    +
    extensions: Extension[]

    Gets a list of CSR extensions

    +
    publicKey: PublicKey

    Gets a public key of CSR

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    signature: ArrayBuffer

    Gets a signature

    +
    signatureAlgorithm: HashedAlgorithm

    Gets a signature algorithm

    +
    subject: string

    Gets a string subject name

    +
    subjectName: Name

    Gets the subject value from the certificate as an Name

    +
    tag: string
    tbs: ArrayBuffer

    ToBeSigned block of CSR

    +
    NAME: string = "PKCS#10 Certificate Request"

    Methods

    • Returns attribute of the specified type

      +

    Returns data is Pkcs10CertificateRequest

    Returns Attribute[]

    Returns Extension[]

    Returns string

    Returns Promise<boolean>

    \ No newline at end of file +

    Returns ArrayBuffer

    \ No newline at end of file diff --git a/classes/Pkcs10CertificateRequestGenerator.html b/classes/Pkcs10CertificateRequestGenerator.html index 93d7d985..aff5740c 100644 --- a/classes/Pkcs10CertificateRequestGenerator.html +++ b/classes/Pkcs10CertificateRequestGenerator.html @@ -1,7 +1,7 @@ Pkcs10CertificateRequestGenerator | @peculiar/x509

    Class Pkcs10CertificateRequestGenerator

    Generator of PKCS10 certificate requests

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Returns Promise<Pkcs10CertificateRequest>

    \ No newline at end of file diff --git a/classes/PublicKey.html b/classes/PublicKey.html index 6ea57b19..72abf06e 100644 --- a/classes/PublicKey.html +++ b/classes/PublicKey.html @@ -1,5 +1,5 @@ PublicKey | @peculiar/x509

    Representation of Subject Public Key Info

    -

    Hierarchy

    • PemData<SubjectPublicKeyInfo>
      • PublicKey

    Constructors

    Hierarchy

    • PemData<SubjectPublicKeyInfo>
      • PublicKey

    Constructors

    Properties

    algorithm rawData tag @@ -17,28 +17,28 @@ toArrayBuffer

    Constructors

    • Creates a new instance from ASN.1

      Parameters

      • asn: SubjectPublicKeyInfo

        ASN.1 object

        -

      Returns PublicKey

    • Creates a new instance

      +

    Returns PublicKey

  • Creates a new instance

    Parameters

    • raw: AsnEncodedType

      Encoded buffer (DER, PEM, HEX, Base64, Base64Url)

      -

    Returns PublicKey

  • Properties

    algorithm: Algorithm

    Gets a key algorithm

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    tag: string
    NAME: string = "ASN"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns PublicKey

    Properties

    algorithm: Algorithm

    Gets a key algorithm

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    tag: string
    NAME: string = "ASN"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      Parameters

      • data: any

        Any data

        -

      Returns data is PublicKey

    • Returns a public CryptoKey

      +

    Returns data is PublicKey

    Returns Promise<CryptoKey>

  • Returns a public CryptoKey with specified parameters

    Parameters

    • algorithm: Algorithm | RsaHashedImportParams | EcKeyImportParams

      Algorithm

    • keyUsages: KeyUsage[]

      A list of key usages

    • Optional crypto: Crypto

      Crypto provider. Default is from CryptoProvider

      -

    Returns Promise<CryptoKey>

  • Returns Promise<CryptoKey>

    Returns Promise<ArrayBuffer>

    Returns Promise<ArrayBuffer>

  • Returns a public key thumbprint for specified mechanism

    Parameters

    • algorithm: AlgorithmIdentifier

      Hash algorithm

    • Optional crypto: Crypto

      Crypto provider. Default is from CryptoProvider

      -

    Returns Promise<ArrayBuffer>

  • Returns Promise<ArrayBuffer>

    Returns string

    \ No newline at end of file +

    Returns ArrayBuffer

    \ No newline at end of file diff --git a/classes/RsaAlgorithm.html b/classes/RsaAlgorithm.html index 2fb208cd..75b3f1d9 100644 --- a/classes/RsaAlgorithm.html +++ b/classes/RsaAlgorithm.html @@ -1,5 +1,5 @@ RsaAlgorithm | @peculiar/x509

    Class RsaAlgorithm

    RSA algorithm provider

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Converts WebCrypto algorithm to ASN.1 algorithm

      Parameters

      • alg: Algorithm

        WebCrypto algorithm

      Returns null | AlgorithmIdentifier

      ASN.1 algorithm or null

      -
    • Parameters

      • hash: unknown
      • saltLength: number

      Returns null | RsaSaPssParams

    • Parameters

      • alg: unknown

      Returns null | AlgorithmIdentifier

    \ No newline at end of file +
    • Parameters

      • hash: unknown
      • saltLength: number

      Returns null | RsaSaPssParams

    • Parameters

      • alg: unknown

      Returns null | AlgorithmIdentifier

    \ No newline at end of file diff --git a/classes/ShaAlgorithm.html b/classes/ShaAlgorithm.html index 2efeb0b8..ed67672d 100644 --- a/classes/ShaAlgorithm.html +++ b/classes/ShaAlgorithm.html @@ -1,11 +1,11 @@ ShaAlgorithm | @peculiar/x509

    Class ShaAlgorithm

    SHA algorithm provider

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Converts WebCrypto algorithm to ASN.1 algorithm

      Parameters

      • alg: Algorithm

        WebCrypto algorithm

      Returns null | AlgorithmIdentifier

      ASN.1 algorithm or null

      -
    • Converts ASN.1 algorithm to WebCrypto algorithm

      Parameters

      • alg: AlgorithmIdentifier

        ASN.1 algorithm

      Returns null | Algorithm

      WebCrypto algorithm or null

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/SubjectAlternativeNameExtension.html b/classes/SubjectAlternativeNameExtension.html index b0819417..a05e2c15 100644 --- a/classes/SubjectAlternativeNameExtension.html +++ b/classes/SubjectAlternativeNameExtension.html @@ -1,5 +1,5 @@ SubjectAlternativeNameExtension | @peculiar/x509

    Class SubjectAlternativeNameExtension

    Represents the Subject Alternative Name certificate extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Returns SubjectAlternativeNameExtension

  • Creates a new instance

    Parameters

    • Optional data: JsonGeneralNames

      JSON representation of SAN

    • Optional critical: boolean

      Indicates where extension is critical. Default is false

      -

    Returns SubjectAlternativeNameExtension

  • Properties

    critical: boolean

    Indicates where extension is critical

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "Subject Alternative Name"

    Methods

    Returns SubjectAlternativeNameExtension

    Properties

    critical: boolean

    Indicates where extension is critical

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "Subject Alternative Name"

    Methods

    • Occurs on instance initialization

      +

    Returns data is SubjectAlternativeNameExtension

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/SubjectKeyIdentifierExtension.html b/classes/SubjectKeyIdentifierExtension.html index f13bd12b..58068f33 100644 --- a/classes/SubjectKeyIdentifierExtension.html +++ b/classes/SubjectKeyIdentifierExtension.html @@ -1,5 +1,5 @@ SubjectKeyIdentifierExtension | @peculiar/x509

    Class SubjectKeyIdentifierExtension

    Represents the Subject Key Identifier certificate extension

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    critical keyId rawData @@ -16,21 +16,21 @@ create

    Constructors

    Returns SubjectKeyIdentifierExtension

  • Creates a new instance

    Parameters

    • keyId: string

      Hexadecimal representation of key identifier

    • Optional critical: boolean

      Indicates where extension is critical. Default is false

      -

    Returns SubjectKeyIdentifierExtension

  • Properties

    critical: boolean

    Indicates where extension is critical

    -
    keyId: string

    Gets hexadecimal representation of key identifier

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    type: string

    Gets an extension identifier

    -
    value: ArrayBuffer

    Gets a DER encoded value of extension

    -
    NAME: string = "Subject Key Identifier"

    Methods

    Returns SubjectKeyIdentifierExtension

    Properties

    critical: boolean

    Indicates where extension is critical

    +
    keyId: string

    Gets hexadecimal representation of key identifier

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    type: string

    Gets an extension identifier

    +
    value: ArrayBuffer

    Gets a DER encoded value of extension

    +
    NAME: string = "Subject Key Identifier"

    Methods

    • Occurs on instance initialization

      +

    Returns data is SubjectKeyIdentifierExtension

    Returns void

    \ No newline at end of file +

    Returns Promise<SubjectKeyIdentifierExtension>

    \ No newline at end of file diff --git a/classes/TextConverter.html b/classes/TextConverter.html index 9583fd66..ab53ecff 100644 --- a/classes/TextConverter.html +++ b/classes/TextConverter.html @@ -1,4 +1,4 @@ -TextConverter | @peculiar/x509

    Class TextConverterAbstract

    Constructors

    constructor +TextConverter | @peculiar/x509

    Class TextConverterAbstract

    Constructors

    Properties

    algorithmSerializer: AlgorithmSerializer = DefaultAlgorithmSerializer
    oidSerializer: typeof OidSerializer = OidSerializer

    Methods

    • Parameters

      • buffer: BufferSource
      • deep: number = 0

      Returns string[]

    \ No newline at end of file +

    Constructors

    Properties

    algorithmSerializer: AlgorithmSerializer = DefaultAlgorithmSerializer
    oidSerializer: typeof OidSerializer = OidSerializer

    Methods

    • Parameters

      • buffer: BufferSource
      • deep: number = 0

      Returns string[]

    \ No newline at end of file diff --git a/classes/TextObject.html b/classes/TextObject.html index c73ece2e..97729afa 100644 --- a/classes/TextObject.html +++ b/classes/TextObject.html @@ -1,6 +1,6 @@ -TextObject | @peculiar/x509

    Class TextObject

    Indexable

    [key: string | symbol]: TextObjectItemType

    Constructors

    constructor +TextObject | @peculiar/x509

    Class TextObject

    Indexable

    [key: string | symbol]: TextObjectItemType

    Constructors

    Properties

    Constructors

    Properties

    [NAME]: string
    [VALUE]: string
    NAME: typeof NAME = NAME
    VALUE: typeof VALUE = VALUE
    \ No newline at end of file +

    Constructors

    Properties

    [NAME]: string
    [VALUE]: string
    NAME: typeof NAME = NAME
    VALUE: typeof VALUE = VALUE
    \ No newline at end of file diff --git a/classes/X509Certificate.html b/classes/X509Certificate.html index e6e9ffe3..7c4934a7 100644 --- a/classes/X509Certificate.html +++ b/classes/X509Certificate.html @@ -1,5 +1,5 @@ X509Certificate | @peculiar/x509

    Class X509Certificate

    Representation of X509 certificate

    -

    Hierarchy

    • PemData<Certificate>
      • X509Certificate

    Implements

    Constructors

    Hierarchy

    • PemData<Certificate>
      • X509Certificate

    Implements

    Constructors

    Properties

    Constructors

    Returns X509Certificate

  • Creates a new instance

    Parameters

    • raw: AsnEncodedType

      Encoded buffer (DER, PEM, HEX, Base64, Base64Url)

      -

    Returns X509Certificate

  • Properties

    extensions: Extension[]

    Gts a list of certificate extensions

    -
    issuer: string

    Gets a string issuer name

    -
    issuerName: Name

    Gets the issuer value from the certificate as an Name

    -
    notAfter: Date

    Gets a date after which certificate can't be used

    -
    notBefore: Date

    Gets a date before which certificate can't be used

    -
    privateKey?: CryptoKey

    Gets a private key of the certificate

    -
    publicKey: PublicKey

    Gets a public key of the certificate

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    serialNumber: string

    Gets a hexadecimal string of the serial number

    -
    signature: ArrayBuffer

    Gets a signature

    -
    signatureAlgorithm: HashedAlgorithm

    Gets a signature algorithm

    -
    subject: string

    Gets a string subject name

    -
    subjectName: Name

    Gets the subject value from the certificate as an Name

    -
    tag: string
    tbs: ArrayBuffer

    ToBeSigned block of certificate

    -
    NAME: string = "Certificate"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns X509Certificate

    Properties

    extensions: Extension[]

    Gts a list of certificate extensions

    +
    issuer: string

    Gets a string issuer name

    +
    issuerName: Name

    Gets the issuer value from the certificate as an Name

    +
    notAfter: Date

    Gets a date after which certificate can't be used

    +
    notBefore: Date

    Gets a date before which certificate can't be used

    +
    privateKey?: CryptoKey

    Gets a private key of the certificate

    +
    publicKey: PublicKey

    Gets a public key of the certificate

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    serialNumber: string

    Gets a hexadecimal string of the serial number

    +
    signature: ArrayBuffer

    Gets a signature

    +
    signatureAlgorithm: HashedAlgorithm

    Gets a signature algorithm

    +
    subject: string

    Gets a string subject name

    +
    subjectName: Name

    Gets the subject value from the certificate as an Name

    +
    tag: string
    tbs: ArrayBuffer

    ToBeSigned block of certificate

    +
    NAME: string = "Certificate"

    Methods

    • Returns an extension of specified type

      +

    Returns data is X509Certificate

    Returns T[]

  • Returns a list of extensions of specified type

    Type Parameters

    Parameters

    • type: (new (raw) => T)

      Extension type

      -
        • new (raw): T
        • Parameters

          • raw: BufferSource

          Returns T

    Returns T[]

  • Returns T[]

    Returns Promise<ArrayBuffer>

  • Returns a certificate thumbprint for specified mechanism

    Parameters

    • algorithm: AlgorithmIdentifier

      Hash algorithm

    • Optional crypto: Crypto

      Crypto provider. Default is from CryptoProvider

      -

    Returns Promise<ArrayBuffer>

  • Returns Promise<ArrayBuffer>

    Returns string

    Returns Promise<boolean>

    \ No newline at end of file +

    Returns ArrayBuffer

    \ No newline at end of file diff --git a/classes/X509CertificateGenerator.html b/classes/X509CertificateGenerator.html index 69226246..2746bb60 100644 --- a/classes/X509CertificateGenerator.html +++ b/classes/X509CertificateGenerator.html @@ -1,11 +1,11 @@ X509CertificateGenerator | @peculiar/x509

    Class X509CertificateGenerator

    Generator of X509 certificates

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • Creates a self-signed certificate

      +

    Returns Promise<X509Certificate>

    \ No newline at end of file +

    Returns Promise<X509Certificate>

    \ No newline at end of file diff --git a/classes/X509Certificates.html b/classes/X509Certificates.html index 7d29d60a..38c3a61a 100644 --- a/classes/X509Certificates.html +++ b/classes/X509Certificates.html @@ -1,5 +1,5 @@ X509Certificates | @peculiar/x509

    Class X509Certificates

    X509 Certificate collection

    -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    Implements

    Constructors

    Properties

    [unscopables] length [species] @@ -44,13 +44,13 @@ isArray of

    Constructors

    Returns X509Certificates

  • Creates a new instance form X509 certificate

    Parameters

    Returns X509Certificates

  • Creates a new instance from a list of x509 certificates

    +
  • Returns X509Certificates

  • Creates a new instance from a list of x509 certificates

    Parameters

    Returns X509Certificates

  • Properties

    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        at?: any;
        concat?: any;
        copyWithin?: any;
        entries?: any;
        every?: any;
        fill?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        flat?: any;
        flatMap?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        pop?: any;
        push?: any;
        reduce?: any;
        reduceRight?: any;
        reverse?: any;
        shift?: any;
        slice?: any;
        some?: any;
        sort?: any;
        splice?: any;
        toLocaleString?: any;
        toString?: any;
        unshift?: any;
        values?: any;
    }

    Is an object whose properties have the value 'true' +

    Returns X509Certificates

    Properties

    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        at?: any;
        concat?: any;
        copyWithin?: any;
        entries?: any;
        every?: any;
        fill?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        flat?: any;
        flatMap?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        pop?: any;
        push?: any;
        reduce?: any;
        reduceRight?: any;
        reverse?: any;
        shift?: any;
        slice?: any;
        some?: any;
        sort?: any;
        splice?: any;
        toLocaleString?: any;
        toString?: any;
        unshift?: any;
        values?: any;
    }

    Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Type declaration

    • Optional Readonly [unscopables]?: boolean

      Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      @@ -61,7 +61,7 @@ allowing for positive and negative integers. Negative integers count back from the last item in the array.

      Parameters

      • index: number

      Returns undefined | X509Certificate

    • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

      Parameters

      • Rest ...items: ConcatArray<X509Certificate>[]

        Additional arrays and/or items to add to the end of the array.

      Returns X509Certificate[]

    • Combines two or more arrays. @@ -88,11 +88,11 @@

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

    • Returns encoded object in PEM format

      -

      Returns string

    • Returns encoded object in DER format

      +

      Returns string

    • Returns encoded object in DER format

      Parameters

      • format: "raw"

        der format

        -

      Returns ArrayBuffer

    • Returns encoded object in selected format

      +

    Returns ArrayBuffer

  • Returns encoded object in selected format

    Parameters

    • Optional format: AsnExportType

      hex, base64, base64url, pem. Default is pem

      -

    Returns string

    • Changes all array elements from start to end index to a static value and returns the modified array

      +

    Returns string

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: X509Certificate

        value to fill array section with

      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        @@ -132,7 +132,7 @@

        Parameters

        • callbackfn: ((value, index, array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    • Import certificates from encoded PKCS7 data. Supported formats are HEX, DER, Base64, Base64Url, PEM

      -

      Parameters

      • data: AsnEncodedType

      Returns void

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      +

      Parameters

      • data: AsnEncodedType

      Returns void

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: X509Certificate

        The element to search for.

      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      @@ -195,8 +195,8 @@
    • Rest ...items: X509Certificate[]

      Elements to insert into the array in place of the deleted elements.

    Returns X509Certificate[]

    An array containing the elements that were deleted.

    • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

      -

      Returns string

    • Inserts new elements at the start of an array, and returns the new length of the array.

      +

      Returns string

    • Inserts new elements at the start of an array, and returns the new length of the array.

      Parameters

      • Rest ...items: X509Certificate[]

        Elements to insert at the start of the array.

      Returns number

    • Returns an iterable of values in the array

      Returns IterableIterator<X509Certificate>

    Constructors

    Properties

    certificates: X509Certificate[] = []

    Methods

    \ No newline at end of file diff --git a/classes/X509Crl.html b/classes/X509Crl.html index f81d0024..120e14f1 100644 --- a/classes/X509Crl.html +++ b/classes/X509Crl.html @@ -1,5 +1,5 @@ X509Crl | @peculiar/x509

    Representation of X.509 Certificate Revocation List (CRL)

    -

    Hierarchy

    • PemData<CertificateList>
      • X509Crl

    Constructors

    Hierarchy

    • PemData<CertificateList>
      • X509Crl

    Constructors

    Properties

    Constructors

    • Creates a new instance from ASN.1 CertificateList object

      Parameters

      • asn: CertificateList

        ASN.1 CertificateList object

        -

      Returns X509Crl

    • Creates a new instance

      +

    Returns X509Crl

  • Creates a new instance

    Parameters

    • raw: AsnEncodedType

      Encoded buffer (DER, PEM, HEX, Base64, Base64Url)

      -

    Returns X509Crl

  • Properties

    certListSignatureAlgorithm: AlgorithmIdentifier

    Signature algorithm field in the sequence CertificateList

    -
    entries: readonly X509CrlEntry[]

    Gets a crlEntries from the CRL

    -
    extensions: Extension[]

    Gts a list of crl extensions

    -
    issuer: string

    Gets a string issuer name

    -
    issuerName: Name

    Gets the issuer value from the crl as an Name

    -
    nextUpdate?: Date

    Gets a nextUpdate date from the CRL

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    signature: ArrayBuffer

    Gets a signature

    -
    signatureAlgorithm: HashedAlgorithm

    Gets a signature algorithm

    -
    tag: string
    tbs: ArrayBuffer

    ToBeSigned block of crl

    -
    tbsCertListSignatureAlgorithm: AlgorithmIdentifier

    Signature field in the sequence tbsCertList

    -
    thisUpdate: Date

    Gets a thisUpdate date from the CRL

    -
    version?: Version

    Gets a version

    -
    NAME: string = "ASN"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      +

    Returns X509Crl

    Properties

    certListSignatureAlgorithm: AlgorithmIdentifier

    Signature algorithm field in the sequence CertificateList

    +
    entries: readonly X509CrlEntry[]

    Gets a crlEntries from the CRL

    +
    extensions: Extension[]

    Gts a list of crl extensions

    +
    issuer: string

    Gets a string issuer name

    +
    issuerName: Name

    Gets the issuer value from the crl as an Name

    +
    nextUpdate?: Date

    Gets a nextUpdate date from the CRL

    +
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    signature: ArrayBuffer

    Gets a signature

    +
    signatureAlgorithm: HashedAlgorithm

    Gets a signature algorithm

    +
    tag: string
    tbs: ArrayBuffer

    ToBeSigned block of crl

    +
    tbsCertListSignatureAlgorithm: AlgorithmIdentifier

    Signature field in the sequence tbsCertList

    +
    thisUpdate: Date

    Gets a thisUpdate date from the CRL

    +
    version?: Version

    Gets a version

    +
    NAME: string = "ASN"

    Methods

    • Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

      Parameters

      • data: any

        Any data

        -

      Returns data is X509Crl

    • Gets the CRL entry, with the given X509Certificate or certificate serialNumber.

      +

    Returns data is X509Crl

    Returns null | X509CrlEntry

    Returns T[]

  • Returns a list of extensions of specified type

    Type Parameters

    Parameters

    • type: (new (raw) => T)

      Extension type

      -
        • new (raw): T
        • Parameters

          • raw: BufferSource

          Returns T

    Returns T[]

  • Returns T[]

    Returns Promise<ArrayBuffer>

  • Returns a certificate thumbprint for specified mechanism

    Parameters

    • algorithm: AlgorithmIdentifier

      Hash algorithm

    • Optional crypto: Crypto

      Crypto provider. Default is from CryptoProvider

      -

    Returns Promise<ArrayBuffer>

  • Returns Promise<ArrayBuffer>

    Returns string

    Returns Promise<boolean>

    \ No newline at end of file +

    Returns ArrayBuffer

    \ No newline at end of file diff --git a/classes/X509CrlEntry.html b/classes/X509CrlEntry.html index db4cb62f..20500b59 100644 --- a/classes/X509CrlEntry.html +++ b/classes/X509CrlEntry.html @@ -1,5 +1,5 @@ X509CrlEntry | @peculiar/x509

    Class X509CrlEntry

    Representation of X509CrlEntry

    -

    Hierarchy (view full)

    • AsnData<RevokedCertificate>
      • X509CrlEntry

    Constructors

    Hierarchy (view full)

    • AsnData<RevokedCertificate>
      • X509CrlEntry

    Constructors

    Properties

    Constructors

    Returns X509CrlEntry

  • Creates a new instance

    Parameters

    • serialNumber: string

      Serial number of certificate

    • revocationDate: Date

      Revocation date

    • extensions: Extension[]

      List of crl extensions

      -

    Returns X509CrlEntry

  • Properties

    extensions: Extension[]

    Gets crl entry extensions

    -
    invalidity?: Date

    Gets the invalidity Date +

    Returns X509CrlEntry

    Properties

    extensions: Extension[]

    Gets crl entry extensions

    +
    invalidity?: Date

    Gets the invalidity Date The invalidity date is a non-critical CRL entry extension that provides the date on which it is known or suspected that the private key was compromised or that the certificate otherwise became invalid.

    -
    rawData: ArrayBuffer

    Gets a DER encoded buffer

    -
    reason?: X509CrlReason

    Gets the reason code

    -
    revocationDate: Date

    Gets the revocation date

    -
    serialNumber: string

    Gets a hexadecimal string of the serial number, the userCertificate

    -
    NAME: string = "ASN"

    Methods

    rawData: ArrayBuffer

    Gets a DER encoded buffer

    +
    reason?: X509CrlReason

    Gets the reason code

    +
    revocationDate: Date

    Gets the revocation date

    +
    serialNumber: string

    Gets a hexadecimal string of the serial number, the userCertificate

    +
    NAME: string = "ASN"

    Methods

    • Occurs on instance initialization

      +

    Returns data is X509CrlEntry

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/X509CrlGenerator.html b/classes/X509CrlGenerator.html index 6e8ece3f..7d785b80 100644 --- a/classes/X509CrlGenerator.html +++ b/classes/X509CrlGenerator.html @@ -1,7 +1,7 @@ X509CrlGenerator | @peculiar/x509

    Class X509CrlGenerator

    Generator of X509 crl

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Returns Promise<X509Crl>

    \ No newline at end of file diff --git a/enums/ExtendedKeyUsage.html b/enums/ExtendedKeyUsage.html index e7642619..906d3e0a 100644 --- a/enums/ExtendedKeyUsage.html +++ b/enums/ExtendedKeyUsage.html @@ -1,7 +1,7 @@ -ExtendedKeyUsage | @peculiar/x509

    Enumeration ExtendedKeyUsage

    Enumeration Members

    clientAuth +ExtendedKeyUsage | @peculiar/x509

    Enumeration ExtendedKeyUsage

    Enumeration Members

    clientAuth: "1.3.6.1.5.5.7.3.2"
    codeSigning: "1.3.6.1.5.5.7.3.3"
    emailProtection: "1.3.6.1.5.5.7.3.4"
    ocspSigning: "1.3.6.1.5.5.7.3.9"
    serverAuth: "1.3.6.1.5.5.7.3.1"
    timeStamping: "1.3.6.1.5.5.7.3.8"
    \ No newline at end of file +

    Enumeration Members

    clientAuth: "1.3.6.1.5.5.7.3.2"
    codeSigning: "1.3.6.1.5.5.7.3.3"
    emailProtection: "1.3.6.1.5.5.7.3.4"
    ocspSigning: "1.3.6.1.5.5.7.3.9"
    serverAuth: "1.3.6.1.5.5.7.3.1"
    timeStamping: "1.3.6.1.5.5.7.3.8"
    \ No newline at end of file diff --git a/enums/KeyUsageFlags.html b/enums/KeyUsageFlags.html index 7b1df594..f60ece89 100644 --- a/enums/KeyUsageFlags.html +++ b/enums/KeyUsageFlags.html @@ -1,5 +1,5 @@ KeyUsageFlags | @peculiar/x509

    Enumeration KeyUsageFlags

    X509 key usages flags

    -

    Enumeration Members

    Enumeration Members

    cRLSign: 64
    dataEncipherment: 8
    decipherOnly: 256
    digitalSignature: 1
    encipherOnly: 128
    keyAgreement: 16
    keyCertSign: 32
    keyEncipherment: 4
    nonRepudiation: 2
    \ No newline at end of file +

    Enumeration Members

    cRLSign: 64
    dataEncipherment: 8
    decipherOnly: 256
    digitalSignature: 1
    encipherOnly: 128
    keyAgreement: 16
    keyCertSign: 32
    keyEncipherment: 4
    nonRepudiation: 2
    \ No newline at end of file diff --git a/enums/X509CrlReason.html b/enums/X509CrlReason.html index 94684e4c..9e3c3e06 100644 --- a/enums/X509CrlReason.html +++ b/enums/X509CrlReason.html @@ -1,7 +1,7 @@ X509CrlReason | @peculiar/x509

    Enumeration X509CrlReason

    Reason Code The reasonCode is a non-critical CRL entry extension that identifies the reason for the certificate revocation.

    -

    Enumeration Members

    Enumeration Members

    aACompromise: 10
    affiliationChanged: 3
    cACompromise: 2
    certificateHold: 6
    cessationOfOperation: 5
    keyCompromise: 1
    privilegeWithdrawn: 9
    removeFromCRL: 8
    superseded: 4
    unspecified: 0
    \ No newline at end of file +

    Enumeration Members

    aACompromise: 10
    affiliationChanged: 3
    cACompromise: 2
    certificateHold: 6
    cessationOfOperation: 5
    keyCompromise: 1
    privilegeWithdrawn: 9
    removeFromCRL: 8
    superseded: 4
    unspecified: 0
    \ No newline at end of file diff --git a/interfaces/AlgorithmSerializer.html b/interfaces/AlgorithmSerializer.html index 4b1f9f8b..e1a6fa5e 100644 --- a/interfaces/AlgorithmSerializer.html +++ b/interfaces/AlgorithmSerializer.html @@ -1,2 +1,2 @@ -AlgorithmSerializer | @peculiar/x509

    Interface AlgorithmSerializer

    interface AlgorithmSerializer {
        toTextObject(alg): TextObject;
    }

    Methods

    Methods

    \ No newline at end of file +AlgorithmSerializer | @peculiar/x509

    Interface AlgorithmSerializer

    interface AlgorithmSerializer {
        toTextObject(alg): TextObject;
    }

    Methods

    Methods

    \ No newline at end of file diff --git a/interfaces/CertificateIdentifier.html b/interfaces/CertificateIdentifier.html index e15e7fe3..0363630d 100644 --- a/interfaces/CertificateIdentifier.html +++ b/interfaces/CertificateIdentifier.html @@ -1,5 +1,5 @@ -CertificateIdentifier | @peculiar/x509

    Interface CertificateIdentifier

    interface CertificateIdentifier {
        name: GeneralNames | GeneralNames | GeneralName[];
        serialNumber: string;
    }

    Properties

    name +CertificateIdentifier | @peculiar/x509

    Interface CertificateIdentifier

    interface CertificateIdentifier {
        name: GeneralNames | GeneralNames | GeneralName[];
        serialNumber: string;
    }

    Properties

    Properties

    name: GeneralNames | GeneralNames | GeneralName[]

    Name

    -
    serialNumber: string

    Hexadecimal string

    -
    \ No newline at end of file +
    serialNumber: string

    Hexadecimal string

    +
    \ No newline at end of file diff --git a/interfaces/HashedAlgorithm.html b/interfaces/HashedAlgorithm.html index cb01dbcc..65f6706d 100644 --- a/interfaces/HashedAlgorithm.html +++ b/interfaces/HashedAlgorithm.html @@ -1,3 +1,3 @@ -HashedAlgorithm | @peculiar/x509

    Interface HashedAlgorithm

    interface HashedAlgorithm {
        hash: Algorithm;
        name: string;
    }

    Hierarchy

    • Algorithm
      • HashedAlgorithm

    Properties

    hash +HashedAlgorithm | @peculiar/x509

    Interface HashedAlgorithm

    interface HashedAlgorithm {
        hash: Algorithm;
        name: string;
    }

    Hierarchy

    • Algorithm
      • HashedAlgorithm

    Properties

    Properties

    hash: Algorithm
    name: string
    \ No newline at end of file +

    Properties

    hash: Algorithm
    name: string
    \ No newline at end of file diff --git a/interfaces/IAlgorithm.html b/interfaces/IAlgorithm.html index ffae58c5..86d406b6 100644 --- a/interfaces/IAlgorithm.html +++ b/interfaces/IAlgorithm.html @@ -1,9 +1,9 @@ -IAlgorithm | @peculiar/x509

    Interface IAlgorithm

    interface IAlgorithm {
        toAsnAlgorithm(alg): null | AlgorithmIdentifier;
        toWebAlgorithm(alg): null | Algorithm;
    }

    Implemented by

    Methods

    toAsnAlgorithm +IAlgorithm | @peculiar/x509

    Interface IAlgorithm

    interface IAlgorithm {
        toAsnAlgorithm(alg): null | AlgorithmIdentifier;
        toWebAlgorithm(alg): null | Algorithm;
    }

    Implemented by

    Methods

    • Converts WebCrypto algorithm to ASN.1 algorithm

      Parameters

      • alg: Algorithm

        WebCrypto algorithm

      Returns null | AlgorithmIdentifier

      ASN.1 algorithm or null

      -
    • Converts ASN.1 algorithm to WebCrypto algorithm

      +
    • Converts ASN.1 algorithm to WebCrypto algorithm

      Parameters

      • alg: AlgorithmIdentifier

        ASN.1 algorithm

      Returns null | Algorithm

      WebCrypto algorithm or null

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/IAsnSignatureFormatter.html b/interfaces/IAsnSignatureFormatter.html index 645cd4c0..4ce35fec 100644 --- a/interfaces/IAsnSignatureFormatter.html +++ b/interfaces/IAsnSignatureFormatter.html @@ -2,10 +2,10 @@

    To register it's implementation in global use tsyringe container

    Example

    import { container } from "tsyringe";

    container.registerSingleton(diAsnSignatureFormatter, AsnDefaultSignatureFormatter);
    -
    interface IAsnSignatureFormatter {
        toAsnSignature(algorithm, signature): null | ArrayBuffer;
        toWebSignature(algorithm, signature): null | ArrayBuffer;
    }

    Implemented by

    Methods

    interface IAsnSignatureFormatter {
        toAsnSignature(algorithm, signature): null | ArrayBuffer;
        toWebSignature(algorithm, signature): null | ArrayBuffer;
    }

    Implemented by

    Methods

    • Converts ASN.1 signature to WebCrypto format

      Parameters

      • algorithm: Algorithm

        Key and signing algorithm

      • signature: BufferSource

        ASN.1 signature value in DER format

        -

      Returns null | ArrayBuffer

    • Converts WebCrypto signature to ASN.1 DER encoded signature value

      -

      Parameters

      • algorithm: Algorithm
      • signature: BufferSource

      Returns null | ArrayBuffer

    \ No newline at end of file +

    Returns null | ArrayBuffer

    • Converts WebCrypto signature to ASN.1 DER encoded signature value

      +

      Parameters

      • algorithm: Algorithm
      • signature: BufferSource

      Returns null | ArrayBuffer

    \ No newline at end of file diff --git a/interfaces/IPublicKeyContainer.html b/interfaces/IPublicKeyContainer.html index a8e7b3b1..d9c536d7 100644 --- a/interfaces/IPublicKeyContainer.html +++ b/interfaces/IPublicKeyContainer.html @@ -1,2 +1,2 @@ -IPublicKeyContainer | @peculiar/x509

    Interface IPublicKeyContainer

    interface IPublicKeyContainer {
        publicKey: PublicKey;
    }

    Implemented by

    Properties

    Properties

    publicKey: PublicKey
    \ No newline at end of file +IPublicKeyContainer | @peculiar/x509

    Interface IPublicKeyContainer

    interface IPublicKeyContainer {
        publicKey: PublicKey;
    }

    Implemented by

    Properties

    Properties

    publicKey: PublicKey
    \ No newline at end of file diff --git a/interfaces/IdOrName.html b/interfaces/IdOrName.html index 7b531ff9..8c85246e 100644 --- a/interfaces/IdOrName.html +++ b/interfaces/IdOrName.html @@ -1 +1 @@ -IdOrName | @peculiar/x509

    Interface IdOrName

    interface IdOrName {
        [idOrName: string]: string;
    }

    Indexable

    [idOrName: string]: string
    \ No newline at end of file +IdOrName | @peculiar/x509

    Interface IdOrName

    interface IdOrName {
        [idOrName: string]: string;
    }

    Indexable

    [idOrName: string]: string
    \ No newline at end of file diff --git a/interfaces/JsonAttributeAndObjectValue.html b/interfaces/JsonAttributeAndObjectValue.html index ad4dbb6a..5850e3e6 100644 --- a/interfaces/JsonAttributeAndObjectValue.html +++ b/interfaces/JsonAttributeAndObjectValue.html @@ -1 +1 @@ -JsonAttributeAndObjectValue | @peculiar/x509

    Interface JsonAttributeAndObjectValue

    interface JsonAttributeAndObjectValue {
        [type: string]: JsonAttributeObject[];
    }

    Indexable

    [type: string]: JsonAttributeObject[]
    \ No newline at end of file +JsonAttributeAndObjectValue | @peculiar/x509

    Interface JsonAttributeAndObjectValue

    interface JsonAttributeAndObjectValue {
        [type: string]: JsonAttributeObject[];
    }

    Indexable

    [type: string]: JsonAttributeObject[]
    \ No newline at end of file diff --git a/interfaces/JsonAttributeAndStringValue.html b/interfaces/JsonAttributeAndStringValue.html index 40c408b9..a603634e 100644 --- a/interfaces/JsonAttributeAndStringValue.html +++ b/interfaces/JsonAttributeAndStringValue.html @@ -1,2 +1,2 @@ JsonAttributeAndStringValue | @peculiar/x509

    Interface JsonAttributeAndStringValue

    JSON representation of Attribute and Value

    -
    interface JsonAttributeAndStringValue {
        [type: string]: string[];
    }

    Indexable

    [type: string]: string[]
    \ No newline at end of file +
    interface JsonAttributeAndStringValue {
        [type: string]: string[];
    }

    Indexable

    [type: string]: string[]
    \ No newline at end of file diff --git a/interfaces/JsonAttributeObject.html b/interfaces/JsonAttributeObject.html index 6b6a8c97..09e02d98 100644 --- a/interfaces/JsonAttributeObject.html +++ b/interfaces/JsonAttributeObject.html @@ -1,6 +1,6 @@ -JsonAttributeObject | @peculiar/x509

    Interface JsonAttributeObject

    interface JsonAttributeObject {
        bmpString?: string;
        ia5String?: string;
        printableString?: string;
        universalString?: string;
        utf8String?: string;
    }

    Properties

    bmpString? +JsonAttributeObject | @peculiar/x509

    Interface JsonAttributeObject

    interface JsonAttributeObject {
        bmpString?: string;
        ia5String?: string;
        printableString?: string;
        universalString?: string;
        utf8String?: string;
    }

    Properties

    bmpString?: string
    ia5String?: string
    printableString?: string
    universalString?: string
    utf8String?: string
    \ No newline at end of file +

    Properties

    bmpString?: string
    ia5String?: string
    printableString?: string
    universalString?: string
    utf8String?: string
    \ No newline at end of file diff --git a/interfaces/JsonGeneralName.html b/interfaces/JsonGeneralName.html index b3024f61..384164ec 100644 --- a/interfaces/JsonGeneralName.html +++ b/interfaces/JsonGeneralName.html @@ -1,3 +1,3 @@ -JsonGeneralName | @peculiar/x509

    Interface JsonGeneralName

    interface JsonGeneralName {
        type: GeneralNameType;
        value: string;
    }

    Properties

    type +JsonGeneralName | @peculiar/x509

    Interface JsonGeneralName

    interface JsonGeneralName {
        type: GeneralNameType;
        value: string;
    }

    Properties

    Properties

    value: string
    \ No newline at end of file +

    Properties

    value: string
    \ No newline at end of file diff --git a/interfaces/PemHeader.html b/interfaces/PemHeader.html index 84e77e6c..0056370f 100644 --- a/interfaces/PemHeader.html +++ b/interfaces/PemHeader.html @@ -1,3 +1,3 @@ -PemHeader | @peculiar/x509

    Interface PemHeader

    interface PemHeader {
        key: string;
        value: string;
    }

    Properties

    key +PemHeader | @peculiar/x509

    Interface PemHeader

    interface PemHeader {
        key: string;
        value: string;
    }

    Properties

    Properties

    key: string
    value: string
    \ No newline at end of file +

    Properties

    key: string
    value: string
    \ No newline at end of file diff --git a/interfaces/PemStruct.html b/interfaces/PemStruct.html index 02406193..917de429 100644 --- a/interfaces/PemStruct.html +++ b/interfaces/PemStruct.html @@ -1,8 +1,8 @@ PemStruct | @peculiar/x509

    Interface PemStruct

    Represents PEM structure

    -
    interface PemStruct {
        headers: PemHeader[];
        rawData: ArrayBuffer;
        type: string;
    }

    Properties

    interface PemStruct {
        headers: PemHeader[];
        rawData: ArrayBuffer;
        type: string;
    }

    Properties

    Properties

    headers: PemHeader[]

    Headers

    -
    rawData: ArrayBuffer

    Decoded message data

    -
    type: string

    Type

    -
    \ No newline at end of file +
    rawData: ArrayBuffer

    Decoded message data

    +
    type: string

    Type

    +
    \ No newline at end of file diff --git a/interfaces/Pkcs10CertificateRequestCreateParams.html b/interfaces/Pkcs10CertificateRequestCreateParams.html index 72becf2d..f122cdd2 100644 --- a/interfaces/Pkcs10CertificateRequestCreateParams.html +++ b/interfaces/Pkcs10CertificateRequestCreateParams.html @@ -1,12 +1,12 @@ Pkcs10CertificateRequestCreateParams | @peculiar/x509

    Interface Pkcs10CertificateRequestCreateParams

    Pkcs10CertificateRequest create parameters

    -
    interface Pkcs10CertificateRequestCreateParams {
        attributes?: Attribute[];
        extensions?: Extension[];
        keys: CryptoKeyPair;
        name?: Pkcs10CertificateRequestCreateParamsName;
        signingAlgorithm: Algorithm | EcdsaParams;
    }

    Properties

    interface Pkcs10CertificateRequestCreateParams {
        attributes?: Attribute[];
        extensions?: Extension[];
        keys: CryptoKeyPair;
        name?: Pkcs10CertificateRequestCreateParamsName;
        signingAlgorithm: Algorithm | EcdsaParams;
    }

    Properties

    attributes?: Attribute[]

    Attributes

    -
    extensions?: Extension[]

    Extensions

    -
    keys: CryptoKeyPair

    Crypto key pair

    -

    Subject name

    -
    signingAlgorithm: Algorithm | EcdsaParams

    Signing algorithm

    -
    \ No newline at end of file +
    extensions?: Extension[]

    Extensions

    +
    keys: CryptoKeyPair

    Crypto key pair

    +

    Subject name

    +
    signingAlgorithm: Algorithm | EcdsaParams

    Signing algorithm

    +
    \ No newline at end of file diff --git a/interfaces/TextObjectConvertible.html b/interfaces/TextObjectConvertible.html index 724a6049..973f1dcc 100644 --- a/interfaces/TextObjectConvertible.html +++ b/interfaces/TextObjectConvertible.html @@ -1,3 +1,3 @@ -TextObjectConvertible | @peculiar/x509

    Interface TextObjectConvertible

    interface TextObjectConvertible {
        toTextObject(): TextObject;
    }

    Implemented by

    Methods

    toTextObject +TextObjectConvertible | @peculiar/x509

    Interface TextObjectConvertible

    interface TextObjectConvertible {
        toTextObject(): TextObject;
    }

    Implemented by

    Methods

    Methods

    \ No newline at end of file +

    Returns TextObject

    \ No newline at end of file diff --git a/interfaces/UnknownAlgorithm.html b/interfaces/UnknownAlgorithm.html index 3d025b97..dab3ff27 100644 --- a/interfaces/UnknownAlgorithm.html +++ b/interfaces/UnknownAlgorithm.html @@ -1,3 +1,3 @@ -UnknownAlgorithm | @peculiar/x509

    Interface UnknownAlgorithm

    interface UnknownAlgorithm {
        name: string;
        parameters?: null | ArrayBuffer;
    }

    Hierarchy

    • Algorithm
      • UnknownAlgorithm

    Properties

    name +UnknownAlgorithm | @peculiar/x509

    Interface UnknownAlgorithm

    interface UnknownAlgorithm {
        name: string;
        parameters?: null | ArrayBuffer;
    }

    Hierarchy

    • Algorithm
      • UnknownAlgorithm

    Properties

    Properties

    name: string
    parameters?: null | ArrayBuffer
    \ No newline at end of file +

    Properties

    name: string
    parameters?: null | ArrayBuffer
    \ No newline at end of file diff --git a/interfaces/X509CertificateCreateCommonParams.html b/interfaces/X509CertificateCreateCommonParams.html index 46deb5ba..e71670bb 100644 --- a/interfaces/X509CertificateCreateCommonParams.html +++ b/interfaces/X509CertificateCreateCommonParams.html @@ -1,5 +1,5 @@ X509CertificateCreateCommonParams | @peculiar/x509

    Interface X509CertificateCreateCommonParams

    Common parameters for X509 Certificate generation

    -
    interface X509CertificateCreateCommonParams {
        extensions?: Extension[];
        issuer?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
        subject?: X509CertificateCreateParamsName;
    }

    Hierarchy (view full)

    Properties

    interface X509CertificateCreateCommonParams {
        extensions?: Extension[];
        issuer?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
        subject?: X509CertificateCreateParamsName;
    }

    Hierarchy (view full)

    Properties

    extensions?: Extension[]

    List of extensions

    -
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    -
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    -
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    -
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    -
    \ No newline at end of file +
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    +
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    +
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    +
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    +
    \ No newline at end of file diff --git a/interfaces/X509CertificateCreateParamsBase.html b/interfaces/X509CertificateCreateParamsBase.html index e9a01579..3e6e93af 100644 --- a/interfaces/X509CertificateCreateParamsBase.html +++ b/interfaces/X509CertificateCreateParamsBase.html @@ -1,12 +1,12 @@ X509CertificateCreateParamsBase | @peculiar/x509

    Interface X509CertificateCreateParamsBase

    Base arguments for certificate creation

    -
    interface X509CertificateCreateParamsBase {
        extensions?: Extension[];
        notAfter?: Date;
        notBefore?: Date;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
    }

    Hierarchy (view full)

    Properties

    interface X509CertificateCreateParamsBase {
        extensions?: Extension[];
        notAfter?: Date;
        notBefore?: Date;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
    }

    Hierarchy (view full)

    Properties

    extensions?: Extension[]

    List of extensions

    -
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    -
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    -
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    -
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    -
    \ No newline at end of file +
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    +
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    +
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    +
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    +
    \ No newline at end of file diff --git a/interfaces/X509CertificateCreateSelfSignedParams.html b/interfaces/X509CertificateCreateSelfSignedParams.html index 2e9171b4..d9894abf 100644 --- a/interfaces/X509CertificateCreateSelfSignedParams.html +++ b/interfaces/X509CertificateCreateSelfSignedParams.html @@ -1,5 +1,5 @@ X509CertificateCreateSelfSignedParams | @peculiar/x509

    Interface X509CertificateCreateSelfSignedParams

    Parameters for self-signed X509 Certificate generation

    -
    interface X509CertificateCreateSelfSignedParams {
        extensions?: Extension[];
        keys: CryptoKeyPair;
        name?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
    }

    Hierarchy (view full)

    Properties

    interface X509CertificateCreateSelfSignedParams {
        extensions?: Extension[];
        keys: CryptoKeyPair;
        name?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
    }

    Hierarchy (view full)

    Properties

    extensions?: Extension[]

    List of extensions

    -
    keys: CryptoKeyPair
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    -
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    -
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    -
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    -
    \ No newline at end of file +
    keys: CryptoKeyPair
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    +
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    +
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    +
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    +
    \ No newline at end of file diff --git a/interfaces/X509CertificateCreateWithKeyParams.html b/interfaces/X509CertificateCreateWithKeyParams.html index c5449e31..2223118a 100644 --- a/interfaces/X509CertificateCreateWithKeyParams.html +++ b/interfaces/X509CertificateCreateWithKeyParams.html @@ -1,5 +1,5 @@ X509CertificateCreateWithKeyParams | @peculiar/x509

    Interface X509CertificateCreateWithKeyParams

    Parameters for X509 Certificate generation with private key

    -
    interface X509CertificateCreateWithKeyParams {
        extensions?: Extension[];
        issuer?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        publicKey: PublicKeyType;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
        signingKey: CryptoKey;
        subject?: X509CertificateCreateParamsName;
    }

    Hierarchy (view full)

    Properties

    interface X509CertificateCreateWithKeyParams {
        extensions?: Extension[];
        issuer?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        publicKey: PublicKeyType;
        serialNumber?: string;
        signingAlgorithm?: Algorithm | EcdsaParams;
        signingKey: CryptoKey;
        subject?: X509CertificateCreateParamsName;
    }

    Hierarchy (view full)

    Properties

    extensions?: Extension[]

    List of extensions

    -
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    -
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    -
    publicKey: PublicKeyType
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    -
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    -
    signingKey: CryptoKey
    \ No newline at end of file +
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    +
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    +
    publicKey: PublicKeyType
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    +
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    +
    signingKey: CryptoKey
    \ No newline at end of file diff --git a/interfaces/X509CertificateCreateWithSignatureParams.html b/interfaces/X509CertificateCreateWithSignatureParams.html index 13a2275a..c819f3cb 100644 --- a/interfaces/X509CertificateCreateWithSignatureParams.html +++ b/interfaces/X509CertificateCreateWithSignatureParams.html @@ -1,5 +1,5 @@ X509CertificateCreateWithSignatureParams | @peculiar/x509

    Interface X509CertificateCreateWithSignatureParams

    Parameters for X509 Certificate generation with existing signature value

    -
    interface X509CertificateCreateWithSignatureParams {
        extensions?: Extension[];
        issuer?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        publicKey: CryptoKey;
        serialNumber?: string;
        signature: BufferSource;
        signingAlgorithm?: Algorithm | EcdsaParams;
        subject?: X509CertificateCreateParamsName;
    }

    Hierarchy (view full)

    Properties

    interface X509CertificateCreateWithSignatureParams {
        extensions?: Extension[];
        issuer?: X509CertificateCreateParamsName;
        notAfter?: Date;
        notBefore?: Date;
        publicKey: CryptoKey;
        serialNumber?: string;
        signature: BufferSource;
        signingAlgorithm?: Algorithm | EcdsaParams;
        subject?: X509CertificateCreateParamsName;
    }

    Hierarchy (view full)

    Properties

    extensions?: Extension[]

    List of extensions

    -
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    -
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    -
    publicKey: CryptoKey

    Manual signing requires CryptoKey that includes signature algorithm

    -
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    -
    signature: BufferSource

    Signature for manually initialized certificates

    -
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    -
    \ No newline at end of file +
    notAfter?: Date

    Date after which certificate can't be used. Default is 1 year from now

    +
    notBefore?: Date

    Date before which certificate can't be used. Default is current date

    +
    publicKey: CryptoKey

    Manual signing requires CryptoKey that includes signature algorithm

    +
    serialNumber?: string

    Hexadecimal serial number. If not specified, random value will be generated

    +
    signature: BufferSource

    Signature for manually initialized certificates

    +
    signingAlgorithm?: Algorithm | EcdsaParams

    Signing algorithm. Default is SHA-256 with key algorithm

    +
    \ No newline at end of file diff --git a/interfaces/X509CertificateVerifyParams.html b/interfaces/X509CertificateVerifyParams.html index ab5acb3a..7d72d0aa 100644 --- a/interfaces/X509CertificateVerifyParams.html +++ b/interfaces/X509CertificateVerifyParams.html @@ -1,5 +1,5 @@ X509CertificateVerifyParams | @peculiar/x509

    Interface X509CertificateVerifyParams

    Verification params of X509 certificate

    -
    interface X509CertificateVerifyParams {
        date?: Date;
        publicKey?: PublicKeyType;
        signatureOnly?: boolean;
    }

    Properties

    interface X509CertificateVerifyParams {
        date?: Date;
        publicKey?: PublicKeyType;
        signatureOnly?: boolean;
    }

    Properties

    date?: Date
    publicKey?: PublicKeyType
    signatureOnly?: boolean
    \ No newline at end of file +

    Properties

    date?: Date
    publicKey?: PublicKeyType
    signatureOnly?: boolean
    \ No newline at end of file diff --git a/interfaces/X509ChainBuilderParams.html b/interfaces/X509ChainBuilderParams.html index d78eb3bf..a6354365 100644 --- a/interfaces/X509ChainBuilderParams.html +++ b/interfaces/X509ChainBuilderParams.html @@ -1,2 +1,2 @@ -X509ChainBuilderParams | @peculiar/x509

    Interface X509ChainBuilderParams

    interface X509ChainBuilderParams {
        certificates?: X509Certificate[];
    }

    Properties

    Properties

    certificates?: X509Certificate[]
    \ No newline at end of file +X509ChainBuilderParams | @peculiar/x509

    Interface X509ChainBuilderParams

    interface X509ChainBuilderParams {
        certificates?: X509Certificate[];
    }

    Properties

    Properties

    certificates?: X509Certificate[]
    \ No newline at end of file diff --git a/interfaces/X509CrlCreateParams.html b/interfaces/X509CrlCreateParams.html index 36e799e7..d8b3375f 100644 --- a/interfaces/X509CrlCreateParams.html +++ b/interfaces/X509CrlCreateParams.html @@ -1,10 +1,10 @@ X509CrlCreateParams | @peculiar/x509

    Interface X509CrlCreateParams

    Parameters for X509 CRL generation

    -
    interface X509CrlCreateParams {
        entries?: X509CrlEntryParams[];
        extensions?: Extension[];
        issuer: X509CertificateCreateParamsName;
        nextUpdate?: Date;
        signingAlgorithm: Algorithm | EcdsaParams;
        signingKey: CryptoKey;
        thisUpdate?: Date;
    }

    Hierarchy (view full)

    Properties

    interface X509CrlCreateParams {
        entries?: X509CrlEntryParams[];
        extensions?: Extension[];
        issuer: X509CertificateCreateParamsName;
        nextUpdate?: Date;
        signingAlgorithm: Algorithm | EcdsaParams;
        signingKey: CryptoKey;
        thisUpdate?: Date;
    }

    Hierarchy (view full)

    Properties

    entries?: X509CrlEntryParams[]
    extensions?: Extension[]
    nextUpdate?: Date
    signingAlgorithm: Algorithm | EcdsaParams

    Signing algorithm

    -
    signingKey: CryptoKey
    thisUpdate?: Date
    \ No newline at end of file +

    Properties

    entries?: X509CrlEntryParams[]
    extensions?: Extension[]
    nextUpdate?: Date
    signingAlgorithm: Algorithm | EcdsaParams

    Signing algorithm

    +
    signingKey: CryptoKey
    thisUpdate?: Date
    \ No newline at end of file diff --git a/interfaces/X509CrlCreateParamsBase.html b/interfaces/X509CrlCreateParamsBase.html index 41d09c86..d19b8478 100644 --- a/interfaces/X509CrlCreateParamsBase.html +++ b/interfaces/X509CrlCreateParamsBase.html @@ -1,6 +1,6 @@ X509CrlCreateParamsBase | @peculiar/x509

    Interface X509CrlCreateParamsBase

    Base arguments for crl creation

    -
    interface X509CrlCreateParamsBase {
        issuer: X509CertificateCreateParamsName;
        signingAlgorithm: Algorithm | EcdsaParams;
        thisUpdate?: Date;
    }

    Hierarchy (view full)

    Properties

    interface X509CrlCreateParamsBase {
        issuer: X509CertificateCreateParamsName;
        signingAlgorithm: Algorithm | EcdsaParams;
        thisUpdate?: Date;
    }

    Hierarchy (view full)

    Properties

    signingAlgorithm: Algorithm | EcdsaParams

    Signing algorithm

    -
    thisUpdate?: Date
    \ No newline at end of file +

    Properties

    signingAlgorithm: Algorithm | EcdsaParams

    Signing algorithm

    +
    thisUpdate?: Date
    \ No newline at end of file diff --git a/interfaces/X509CrlEntryParams.html b/interfaces/X509CrlEntryParams.html index 8d1fec26..be365aa2 100644 --- a/interfaces/X509CrlEntryParams.html +++ b/interfaces/X509CrlEntryParams.html @@ -1,8 +1,8 @@ -X509CrlEntryParams | @peculiar/x509

    Interface X509CrlEntryParams

    interface X509CrlEntryParams {
        extensions?: Extension[];
        invalidity?: Date;
        issuer?: X509CertificateCreateParamsName;
        reason?: X509CrlReason;
        revocationDate?: Date;
        serialNumber: string;
    }

    Properties

    extensions? +X509CrlEntryParams | @peculiar/x509

    Interface X509CrlEntryParams

    interface X509CrlEntryParams {
        extensions?: Extension[];
        invalidity?: Date;
        issuer?: X509CertificateCreateParamsName;
        reason?: X509CrlReason;
        revocationDate?: Date;
        serialNumber: string;
    }

    Properties

    extensions?: Extension[]
    invalidity?: Date
    reason?: X509CrlReason
    revocationDate?: Date
    serialNumber: string

    Hexadecimal serial number

    -
    \ No newline at end of file +

    Properties

    extensions?: Extension[]
    invalidity?: Date
    reason?: X509CrlReason
    revocationDate?: Date
    serialNumber: string

    Hexadecimal serial number

    +
    \ No newline at end of file diff --git a/interfaces/X509CrlVerifyParams.html b/interfaces/X509CrlVerifyParams.html index d4b4b733..7e82c399 100644 --- a/interfaces/X509CrlVerifyParams.html +++ b/interfaces/X509CrlVerifyParams.html @@ -1,2 +1,2 @@ -X509CrlVerifyParams | @peculiar/x509

    Interface X509CrlVerifyParams

    interface X509CrlVerifyParams {
        publicKey: CryptoKey | PublicKey | X509Certificate;
    }

    Properties

    Properties

    publicKey: CryptoKey | PublicKey | X509Certificate
    \ No newline at end of file +X509CrlVerifyParams | @peculiar/x509

    Interface X509CrlVerifyParams

    interface X509CrlVerifyParams {
        publicKey: CryptoKey | PublicKey | X509Certificate;
    }

    Properties

    Properties

    publicKey: CryptoKey | PublicKey | X509Certificate
    \ No newline at end of file diff --git a/types/AsnDataStringFormat.html b/types/AsnDataStringFormat.html index 0f2a8a4e..c7b567b4 100644 --- a/types/AsnDataStringFormat.html +++ b/types/AsnDataStringFormat.html @@ -1 +1 @@ -AsnDataStringFormat | @peculiar/x509

    Type alias AsnDataStringFormat

    AsnDataStringFormat: "asn" | "text" | "hex" | "base64" | "base64url"
    \ No newline at end of file +AsnDataStringFormat | @peculiar/x509

    Type alias AsnDataStringFormat

    AsnDataStringFormat: "asn" | "text" | "hex" | "base64" | "base64url"
    \ No newline at end of file diff --git a/types/ExtendedKeyUsageType.html b/types/ExtendedKeyUsageType.html index 04808aa4..1fc22324 100644 --- a/types/ExtendedKeyUsageType.html +++ b/types/ExtendedKeyUsageType.html @@ -1 +1 @@ -ExtendedKeyUsageType | @peculiar/x509

    Type alias ExtendedKeyUsageType

    ExtendedKeyUsageType: asn1X509.ExtendedKeyUsage | string
    \ No newline at end of file +ExtendedKeyUsageType | @peculiar/x509

    Type alias ExtendedKeyUsageType

    ExtendedKeyUsageType: asn1X509.ExtendedKeyUsage | string
    \ No newline at end of file diff --git a/types/GeneralNameType.html b/types/GeneralNameType.html index 6a33e63a..62118ff2 100644 --- a/types/GeneralNameType.html +++ b/types/GeneralNameType.html @@ -1 +1 @@ -GeneralNameType | @peculiar/x509

    Type alias GeneralNameType

    GeneralNameType: typeof DNS | typeof DN | typeof EMAIL | typeof GUID | typeof IP | typeof URL | typeof UPN | typeof REGISTERED_ID
    \ No newline at end of file +GeneralNameType | @peculiar/x509

    Type alias GeneralNameType

    GeneralNameType: typeof DNS | typeof DN | typeof EMAIL | typeof GUID | typeof IP | typeof URL | typeof UPN | typeof REGISTERED_ID
    \ No newline at end of file diff --git a/types/JsonAttributeAndValue.html b/types/JsonAttributeAndValue.html index 9ddb6899..838063e5 100644 --- a/types/JsonAttributeAndValue.html +++ b/types/JsonAttributeAndValue.html @@ -1 +1 @@ -JsonAttributeAndValue | @peculiar/x509

    Type alias JsonAttributeAndValue

    \ No newline at end of file +JsonAttributeAndValue | @peculiar/x509

    Type alias JsonAttributeAndValue

    \ No newline at end of file diff --git a/types/JsonGeneralNames.html b/types/JsonGeneralNames.html index fe0bfb91..6d92db69 100644 --- a/types/JsonGeneralNames.html +++ b/types/JsonGeneralNames.html @@ -1 +1 @@ -JsonGeneralNames | @peculiar/x509

    Type alias JsonGeneralNames

    JsonGeneralNames: JsonGeneralName[]
    \ No newline at end of file +JsonGeneralNames | @peculiar/x509

    Type alias JsonGeneralNames

    JsonGeneralNames: JsonGeneralName[]
    \ No newline at end of file diff --git a/types/JsonName.html b/types/JsonName.html index 1a3483dc..57fadc91 100644 --- a/types/JsonName.html +++ b/types/JsonName.html @@ -1,2 +1,2 @@ JsonName | @peculiar/x509

    Type alias JsonName

    JSON array of Attribute and Value

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/JsonNameParams.html b/types/JsonNameParams.html index b761689f..f5859089 100644 --- a/types/JsonNameParams.html +++ b/types/JsonNameParams.html @@ -1 +1 @@ -JsonNameParams | @peculiar/x509

    Type alias JsonNameParams

    JsonNameParams: JsonAttributeAndValue[]
    \ No newline at end of file +JsonNameParams | @peculiar/x509

    Type alias JsonNameParams

    JsonNameParams: JsonAttributeAndValue[]
    \ No newline at end of file diff --git a/types/MapForEachCallback.html b/types/MapForEachCallback.html index 73414ac9..f0f2c4f3 100644 --- a/types/MapForEachCallback.html +++ b/types/MapForEachCallback.html @@ -1 +1 @@ -MapForEachCallback | @peculiar/x509

    Type alias MapForEachCallback

    MapForEachCallback: ((value, key, map) => void)

    Type declaration

      • (value, key, map): void
      • Parameters

        • value: Crypto
        • key: string
        • map: Map<string, Crypto>

        Returns void

    \ No newline at end of file +MapForEachCallback | @peculiar/x509

    Type alias MapForEachCallback

    MapForEachCallback: ((value, key, map) => void)

    Type declaration

      • (value, key, map): void
      • Parameters

        • value: Crypto
        • key: string
        • map: Map<string, Crypto>

        Returns void

    \ No newline at end of file diff --git a/types/PemStructEncodeParams.html b/types/PemStructEncodeParams.html index 3a6fb876..3760f366 100644 --- a/types/PemStructEncodeParams.html +++ b/types/PemStructEncodeParams.html @@ -1 +1 @@ -PemStructEncodeParams | @peculiar/x509

    Type alias PemStructEncodeParams

    PemStructEncodeParams: AtLeast<PemStruct, "type" | "rawData">
    \ No newline at end of file +PemStructEncodeParams | @peculiar/x509

    Type alias PemStructEncodeParams

    PemStructEncodeParams: AtLeast<PemStruct, "type" | "rawData">
    \ No newline at end of file diff --git a/types/Pkcs10CertificateRequestCreateParamsName.html b/types/Pkcs10CertificateRequestCreateParamsName.html index 15aa20bd..9550f7d3 100644 --- a/types/Pkcs10CertificateRequestCreateParamsName.html +++ b/types/Pkcs10CertificateRequestCreateParamsName.html @@ -1 +1 @@ -Pkcs10CertificateRequestCreateParamsName | @peculiar/x509

    Type alias Pkcs10CertificateRequestCreateParamsName

    Pkcs10CertificateRequestCreateParamsName: string | JsonName | Name
    \ No newline at end of file +Pkcs10CertificateRequestCreateParamsName | @peculiar/x509

    Type alias Pkcs10CertificateRequestCreateParamsName

    Pkcs10CertificateRequestCreateParamsName: string | JsonName | Name
    \ No newline at end of file diff --git a/types/PublicKeyType.html b/types/PublicKeyType.html index 227a01ba..92f7d78d 100644 --- a/types/PublicKeyType.html +++ b/types/PublicKeyType.html @@ -1 +1 @@ -PublicKeyType | @peculiar/x509

    Type alias PublicKeyType

    PublicKeyType: PublicKey | CryptoKey | IPublicKeyContainer | BufferSource
    \ No newline at end of file +PublicKeyType | @peculiar/x509

    Type alias PublicKeyType

    PublicKeyType: PublicKey | CryptoKey | IPublicKeyContainer | BufferSource
    \ No newline at end of file diff --git a/types/TextObjectItemType.html b/types/TextObjectItemType.html index 1b04bdc8..e64706a8 100644 --- a/types/TextObjectItemType.html +++ b/types/TextObjectItemType.html @@ -1 +1 @@ -TextObjectItemType | @peculiar/x509

    Type alias TextObjectItemType

    TextObjectItemType: string | number | boolean | Date | BufferSource | TextObject | TextObject[] | TextObjectConvertible
    \ No newline at end of file +TextObjectItemType | @peculiar/x509

    Type alias TextObjectItemType

    TextObjectItemType: string | number | boolean | Date | BufferSource | TextObject | TextObject[] | TextObjectConvertible
    \ No newline at end of file diff --git a/types/X509CertificateCreateParams.html b/types/X509CertificateCreateParams.html index ba239e4a..f0ed1c4f 100644 --- a/types/X509CertificateCreateParams.html +++ b/types/X509CertificateCreateParams.html @@ -1 +1 @@ -X509CertificateCreateParams | @peculiar/x509
    \ No newline at end of file +X509CertificateCreateParams | @peculiar/x509
    \ No newline at end of file diff --git a/types/X509CertificateCreateParamsName.html b/types/X509CertificateCreateParamsName.html index c39ef3dd..fd3a7502 100644 --- a/types/X509CertificateCreateParamsName.html +++ b/types/X509CertificateCreateParamsName.html @@ -1 +1 @@ -X509CertificateCreateParamsName | @peculiar/x509

    Type alias X509CertificateCreateParamsName

    X509CertificateCreateParamsName: string | JsonName | Name
    \ No newline at end of file +X509CertificateCreateParamsName | @peculiar/x509

    Type alias X509CertificateCreateParamsName

    X509CertificateCreateParamsName: string | JsonName | Name
    \ No newline at end of file diff --git a/types/X509CertificatesExportType.html b/types/X509CertificatesExportType.html index f7489f40..d72d6db6 100644 --- a/types/X509CertificatesExportType.html +++ b/types/X509CertificatesExportType.html @@ -1 +1 @@ -X509CertificatesExportType | @peculiar/x509

    Type alias X509CertificatesExportType

    X509CertificatesExportType: AsnExportType | "pem-chain"
    \ No newline at end of file +X509CertificatesExportType | @peculiar/x509

    Type alias X509CertificatesExportType

    X509CertificatesExportType: AsnExportType | "pem-chain"
    \ No newline at end of file diff --git a/variables/cryptoProvider-1.html b/variables/cryptoProvider-1.html index 55692606..be107a7b 100644 --- a/variables/cryptoProvider-1.html +++ b/variables/cryptoProvider-1.html @@ -1,2 +1,2 @@ cryptoProvider | @peculiar/x509

    Variable cryptoProviderConst

    cryptoProvider: CryptoProvider = ...

    Singleton crypto provider

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/diAlgorithm.html b/variables/diAlgorithm.html index c3f71dc1..30bd2b84 100644 --- a/variables/diAlgorithm.html +++ b/variables/diAlgorithm.html @@ -1,2 +1,2 @@ diAlgorithm | @peculiar/x509

    Variable diAlgorithmConst

    diAlgorithm: "crypto.algorithm" = "crypto.algorithm"

    Dependency Injection algorithm identifier

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/diAlgorithmProvider.html b/variables/diAlgorithmProvider.html index ac514ade..69896d1f 100644 --- a/variables/diAlgorithmProvider.html +++ b/variables/diAlgorithmProvider.html @@ -1 +1 @@ -diAlgorithmProvider | @peculiar/x509

    Variable diAlgorithmProviderConst

    diAlgorithmProvider: "crypto.algorithmProvider" = "crypto.algorithmProvider"
    \ No newline at end of file +diAlgorithmProvider | @peculiar/x509

    Variable diAlgorithmProviderConst

    diAlgorithmProvider: "crypto.algorithmProvider" = "crypto.algorithmProvider"
    \ No newline at end of file diff --git a/variables/diAsnSignatureFormatter.html b/variables/diAsnSignatureFormatter.html index 2589b0e4..2a3ffcbe 100644 --- a/variables/diAsnSignatureFormatter.html +++ b/variables/diAsnSignatureFormatter.html @@ -1,2 +1,2 @@ diAsnSignatureFormatter | @peculiar/x509

    Variable diAsnSignatureFormatterConst

    diAsnSignatureFormatter: "crypto.signatureFormatter" = "crypto.signatureFormatter"

    Dependency injection identifier for IAsnSignatureFormatter interface

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/idEd25519.html b/variables/idEd25519.html index 0de7b459..c375f6e9 100644 --- a/variables/idEd25519.html +++ b/variables/idEd25519.html @@ -1 +1 @@ -idEd25519 | @peculiar/x509

    Variable idEd25519Const

    idEd25519: "1.3.101.112" = "1.3.101.112"
    \ No newline at end of file +idEd25519 | @peculiar/x509

    Variable idEd25519Const

    idEd25519: "1.3.101.112" = "1.3.101.112"
    \ No newline at end of file diff --git a/variables/idEd448.html b/variables/idEd448.html index 5813ecd2..56e0ab2f 100644 --- a/variables/idEd448.html +++ b/variables/idEd448.html @@ -1 +1 @@ -idEd448 | @peculiar/x509

    Variable idEd448Const

    idEd448: "1.3.101.113" = "1.3.101.113"
    \ No newline at end of file +idEd448 | @peculiar/x509

    Variable idEd448Const

    idEd448: "1.3.101.113" = "1.3.101.113"
    \ No newline at end of file diff --git a/variables/idX25519.html b/variables/idX25519.html index 911abdb1..d01394cf 100644 --- a/variables/idX25519.html +++ b/variables/idX25519.html @@ -1 +1 @@ -idX25519 | @peculiar/x509

    Variable idX25519Const

    idX25519: "1.3.101.110" = "1.3.101.110"
    \ No newline at end of file +idX25519 | @peculiar/x509

    Variable idX25519Const

    idX25519: "1.3.101.110" = "1.3.101.110"
    \ No newline at end of file diff --git a/variables/idX448.html b/variables/idX448.html index b7dc7faf..79dde199 100644 --- a/variables/idX448.html +++ b/variables/idX448.html @@ -1 +1 @@ -idX448 | @peculiar/x509

    Variable idX448Const

    idX448: "1.3.101.111" = "1.3.101.111"
    \ No newline at end of file +idX448 | @peculiar/x509

    Variable idX448Const

    idX448: "1.3.101.111" = "1.3.101.111"
    \ No newline at end of file