Skip to main content

pkijs

Type Aliases​

AccessDescriptionParameters​

AccessDescriptionParameters: PkiObjectParameters & Partial<IAccessDescription>

AccuracyParameters​

AccuracyParameters: PkiObjectParameters & Partial<IAccuracy>

AccuracySchema​

AccuracySchema: SchemaParameters<object>

Type declaration​

micros?​

optional micros: string

millis?​

optional millis: string

seconds?​

optional seconds: string

AlgorithmIdentifierParameters​

AlgorithmIdentifierParameters: PkiObjectParameters & Partial<IAlgorithmIdentifier>

AlgorithmIdentifierSchema​

AlgorithmIdentifierSchema: SchemaParameters<object>

Type declaration​

algorithmIdentifier?​

optional algorithmIdentifier: string

algorithmParams?​

optional algorithmParams: string

AltNameParameters​

AltNameParameters: PkiObjectParameters & Partial<IAltName>

ArgumentType​

ArgumentType: "undefined" | "null" | "boolean" | "number" | "string" | "object" | "Array" | "ArrayBuffer" | "ArrayBufferView" | AnyConstructor

AttCertValidityPeriodParameters​

AttCertValidityPeriodParameters: PkiObjectParameters & Partial<IAttCertValidityPeriod>

AttCertValidityPeriodSchema​

AttCertValidityPeriodSchema: SchemaParameters<object>

Type declaration​

notAfterTime?​

optional notAfterTime: string

notBeforeTime?​

optional notBeforeTime: string

AttributeCertificateInfoV1Parameters​

AttributeCertificateInfoV1Parameters: PkiObjectParameters & Partial<IAttributeCertificateInfoV1>

AttributeCertificateInfoV1Schema​

AttributeCertificateInfoV1Schema: SchemaParameters<object>

Type declaration​

attrCertValidityPeriod?​

optional attrCertValidityPeriod: AttCertValidityPeriodSchema

attributes?​

optional attributes: string

baseCertificateID?​

optional baseCertificateID: string

extensions?​

optional extensions: ExtensionsSchema

issuer?​

optional issuer: string

issuerUniqueID?​

optional issuerUniqueID: string

serialNumber?​

optional serialNumber: string

signature?​

optional signature: AlgorithmIdentifierSchema

subjectName?​

optional subjectName: string

version?​

optional version: string

AttributeCertificateInfoV2Parameters​

AttributeCertificateInfoV2Parameters: PkiObjectParameters & Partial<AttributeCertificateInfoV2>

AttributeCertificateInfoV2Schema​

AttributeCertificateInfoV2Schema: SchemaParameters<object>

Type declaration​

attrCertValidityPeriod?​

optional attrCertValidityPeriod: AttCertValidityPeriodSchema

attributes?​

optional attributes: string

extensions?​

optional extensions: ExtensionsSchema

holder?​

optional holder: HolderSchema

issuer?​

optional issuer: string

issuerUniqueID?​

optional issuerUniqueID: string

serialNumber?​

optional serialNumber: string

signature?​

optional signature: AlgorithmIdentifierSchema

version?​

optional version: string

AttributeCertificateV1Parameters​

AttributeCertificateV1Parameters: PkiObjectParameters & Partial<IAttributeCertificateV1>

AttributeCertificateV2Parameters​

AttributeCertificateV2Parameters: PkiObjectParameters & Partial<IAttributeCertificateV2>

AttributeParameters​

AttributeParameters: PkiObjectParameters & Partial<IAttribute>

AttributeSchema​

AttributeSchema: SchemaParameters<object>

Type declaration​

setName?​

optional setName: string

type?​

optional type: string

values?​

optional values: string

AttributeTypeAndValueParameters​

AttributeTypeAndValueParameters: PkiObjectParameters & Partial<IAttributeTypeAndValue>

AttributeValueType​

AttributeValueType: asn1js.Utf8String | asn1js.BmpString | asn1js.UniversalString | asn1js.NumericString | asn1js.PrintableString | asn1js.TeletexString | asn1js.VideotexString | asn1js.IA5String | asn1js.GraphicString | asn1js.VisibleString | asn1js.GeneralString | asn1js.CharacterString

AuthenticatedSafeParameters​

AuthenticatedSafeParameters: PkiObjectParameters & Partial<IAuthenticatedSafe>

AuthorityKeyIdentifierParameters​

AuthorityKeyIdentifierParameters: PkiObjectParameters & Partial<IAuthorityKeyIdentifier>

BagType​

BagType: PrivateKeyInfo | PKCS8ShroudedKeyBag | CertBag | CRLBag | SecretBag | SafeContents

BagTypeJson​

BagTypeJson: PrivateKeyInfoJson | JsonWebKey | PKCS8ShroudedKeyBagJson | CertBagJson | CRLBagJson | SecretBagJson | SafeContentsJson

BasicConstraintsParameters​

BasicConstraintsParameters: PkiObjectParameters & Partial<IBasicConstraints>

BasicOCSPResponseParameters​

BasicOCSPResponseParameters: PkiObjectParameters & Partial<IBasicOCSPResponse>

CAVersionParameters​

CAVersionParameters: PkiObjectParameters & Partial<ICAVersion>

CertBagParameters​

CertBagParameters: PkiObjectParameters & Partial<ICertBag>

CertIDParameters​

CertIDParameters: PkiObjectParameters & Partial<ICertID>

CertIDSchema​

CertIDSchema: SchemaParameters<object>

Type declaration​

hashAlgorithm?​

optional hashAlgorithm: string

hashAlgorithmObject?​

optional hashAlgorithmObject: AlgorithmIdentifierSchema

issuerKeyHash?​

optional issuerKeyHash: string

issuerNameHash?​

optional issuerNameHash: string

serialNumber?​

optional serialNumber: string

CertificateParameters​

CertificateParameters: PkiObjectParameters & Partial<ICertificate>

Constructor parameters for the Certificate class

CertificatePoliciesParameters​

CertificatePoliciesParameters: PkiObjectParameters & Partial<ICertificatePolicies>

CertificateRevocationListParameters​

CertificateRevocationListParameters: PkiObjectParameters & Partial<ICertificateRevocationList>

CertificateSchema​

CertificateSchema: SchemaParameters<object>

Parameters for Certificate schema generation

Type declaration​

signatureAlgorithm?​

optional signatureAlgorithm: AlgorithmIdentifierSchema

signatureValue?​

optional signatureValue: string

tbsCertificate?​

optional tbsCertificate: TBSCertificateSchema

CertificateSetItem​

CertificateSetItem: Certificate | AttributeCertificateV1 | AttributeCertificateV2 | OtherCertificateFormat

CertificateSetItemJson​

CertificateSetItemJson: CertificateJson | AttributeCertificateV1Json | AttributeCertificateV2Json | OtherCertificateFormatJson

CertificateSetParameters​

CertificateSetParameters: PkiObjectParameters & Partial<ICertificateSet>

CertificateTemplateParameters​

CertificateTemplateParameters: PkiObjectParameters & Partial<ICertificateTemplate>

CertificationRequestParameters​

CertificationRequestParameters: PkiObjectParameters & Partial<ICertificationRequest>

ContentEncryptionAesCbcParams​

ContentEncryptionAesCbcParams: AesCbcParams & AesDerivedKeyParams

ContentEncryptionAesGcmParams​

ContentEncryptionAesGcmParams: AesGcmParams & AesDerivedKeyParams

ContentEncryptionAlgorithm​

ContentEncryptionAlgorithm: ContentEncryptionAesCbcParams | ContentEncryptionAesGcmParams

ContentInfoParameters​

ContentInfoParameters: PkiObjectParameters & Partial<IContentInfo>

ContentInfoSchema​

ContentInfoSchema: SchemaParameters<object>

Type declaration​

content?​

optional content: string

contentType?​

optional contentType: string

CRLBagParameters​

CRLBagParameters: PkiObjectParameters & Partial<ICRLBag>

CRLDistributionPointsParameters​

CRLDistributionPointsParameters: PkiObjectParameters & Partial<ICRLDistributionPoints>

CryptoEngineAlgorithmOperation​

CryptoEngineAlgorithmOperation: "sign" | "encrypt" | "generateKey" | "importKey" | "exportKey" | "verify"

DigestInfoParameters​

DigestInfoParameters: PkiObjectParameters & Partial<IDigestInfo>

DigestInfoSchema​

DigestInfoSchema: SchemaParameters<object>

Type declaration​

digest?​

optional digest: string

digestAlgorithm?​

optional digestAlgorithm: AlgorithmIdentifierSchema

DistributionPointName​

DistributionPointName: GeneralName[] | RelativeDistinguishedNames

DistributionPointNameJson​

DistributionPointNameJson: GeneralNameJson[] | RelativeDistinguishedNamesJson

DistributionPointParameters​

DistributionPointParameters: PkiObjectParameters & Partial<IDistributionPoint>

ECCCMSSharedInfoParameters​

ECCCMSSharedInfoParameters: PkiObjectParameters & Partial<IECCCMSSharedInfo>

ECPrivateKeyParameters​

ECPrivateKeyParameters: PkiObjectParameters & Partial<IECPrivateKey> & object

Type declaration​

json?​

optional json: ECPrivateKeyJson

ECPublicKeyParameters​

ECPublicKeyParameters: PkiObjectParameters & Partial<IECPublicKey> & object

Type declaration​

json?​

optional json: ECPublicKeyJson

EncapsulatedContentInfoParameters​

EncapsulatedContentInfoParameters: PkiObjectParameters & Partial<IEncapsulatedContentInfo>

EncapsulatedContentInfoSchema​

EncapsulatedContentInfoSchema: SchemaParameters<object>

Type declaration​

eContent?​

optional eContent: string

eContentType?​

optional eContentType: string

EncryptedContentInfoSchema​

EncryptedContentInfoSchema: SchemaParameters<object>

Type declaration​

contentEncryptionAlgorithm?​

optional contentEncryptionAlgorithm: AlgorithmIdentifierSchema

contentType?​

optional contentType: string

encryptedContent?​

optional encryptedContent: string

EncryptedContentParameters​

EncryptedContentParameters: PkiObjectParameters & Partial<IEncryptedContentInfo> & EncryptedContentInfoSplit

EncryptedDataEncryptParams​

EncryptedDataEncryptParams: Omit<CryptoEngineEncryptParams, "contentType">

EncryptedDataParameters​

EncryptedDataParameters: PkiObjectParameters & Partial<IEncryptedData>

EnvelopedDataDecryptParams​

EnvelopedDataDecryptParams: EnvelopedDataDecryptBufferParams | EnvelopedDataDecryptKeyParams

EnvelopedDataParameters​

EnvelopedDataParameters: PkiObjectParameters & Partial<IEnvelopedData> & EncryptedContentInfoSplit

ExtensionParameters​

ExtensionParameters: PkiObjectParameters & ExtensionConstructorParameters

ExtensionParsedValue​

ExtensionParsedValue: SchemaCompatible & object | SchemaType

ExtensionSchema​

ExtensionSchema: SchemaParameters<object>

Type declaration​

critical?​

optional critical: string

extnID?​

optional extnID: string

extnValue?​

optional extnValue: string

ExtensionsParameters​

ExtensionsParameters: PkiObjectParameters & Partial<IExtensions>

ExtensionsSchema​

ExtensionsSchema: SchemaParameters<object>

Type declaration​

extension?​

optional extension: ExtensionSchema

extensions?​

optional extensions: string

ExtKeyUsageParameters​

ExtKeyUsageParameters: PkiObjectParameters & Partial<IExtKeyUsage>

FindIssuerCallback()​

FindIssuerCallback: (certificate, validationEngine, crypto?) => Promise<Certificate[]>

Parameters​

• certificate: Certificate

• validationEngine: CertificateChainValidationEngine

• crypto?: ICryptoEngine

Returns​

Promise<Certificate[]>

FindOriginCallback()​

FindOriginCallback: (certificate, validationEngine) => string

Parameters​

• certificate: Certificate

• validationEngine: CertificateChainValidationEngine

Returns​

string

GeneralNameParameters​

GeneralNameParameters: PkiObjectParameters & Partial<object | object>

GeneralNamesParameters​

GeneralNamesParameters: PkiObjectParameters & Partial<IGeneralNames>

GeneralNamesSchema​

GeneralNamesSchema: SchemaParameters<object>

Type declaration​

generalNames?​

optional generalNames: string

GeneralSubtreeParameters​

GeneralSubtreeParameters: PkiObjectParameters & Partial<IGeneralSubtree>

HolderParameters​

HolderParameters: PkiObjectParameters & Partial<IHolder>

HolderSchema​

HolderSchema: SchemaParameters<object>

Type declaration​

baseCertificateID?​

optional baseCertificateID: string

entityName?​

optional entityName: string

objectDigestInfo?​

optional objectDigestInfo: string

InfoAccessParameters​

InfoAccessParameters: PkiObjectParameters & Partial<IInfoAccess>

IssuerAndSerialNumberParameters​

IssuerAndSerialNumberParameters: PkiObjectParameters & Partial<IIssuerAndSerialNumber>

IssuerAndSerialNumberSchema​

IssuerAndSerialNumberSchema: SchemaParameters<object>

Type declaration​

issuer?​

optional issuer: RelativeDistinguishedNamesSchema

serialNumber?​

optional serialNumber: string

IssuerSerialParameters​

IssuerSerialParameters: PkiObjectParameters & Partial<IIssuerSerial>

IssuingDistributionPointParameters​

IssuingDistributionPointParameters: PkiObjectParameters & Partial<IIssuingDistributionPoint>

KEKIdentifierParameters​

KEKIdentifierParameters: PkiObjectParameters & Partial<IKEKIdentifier>

KEKIdentifierSchema​

KEKIdentifierSchema: SchemaParameters<object>

Type declaration​

date?​

optional date: string

keyIdentifier?​

optional keyIdentifier: string

other?​

optional other: OtherKeyAttributeSchema

KEKRecipientInfoParameters​

KEKRecipientInfoParameters: PkiObjectParameters & Partial<IKEKRecipientInfo>

KeyAgreeRecipientIdentifierParameters​

KeyAgreeRecipientIdentifierParameters: PkiObjectParameters & Partial<IKeyAgreeRecipientIdentifier>

KeyAgreeRecipientIdentifierSchema​

KeyAgreeRecipientIdentifierSchema: SchemaParameters<object>

Type declaration​

issuerAndSerialNumber?​

optional issuerAndSerialNumber: IssuerAndSerialNumberSchema

rKeyId?​

optional rKeyId: RecipientKeyIdentifierSchema

KeyAgreeRecipientInfoParameters​

KeyAgreeRecipientInfoParameters: PkiObjectParameters & Partial<IKeyAgreeRecipientInfo>

KeyTransRecipientInfoParameters​

KeyTransRecipientInfoParameters: PkiObjectParameters & Partial<IKeyTransRecipientInfo>

MacDataParameters​

MacDataParameters: PkiObjectParameters & Partial<IMacData>

MacDataSchema​

MacDataSchema: SchemaParameters<object>

Type declaration​

iterations?​

optional iterations: string

mac?​

optional mac: DigestInfoSchema

macSalt?​

optional macSalt: string

MakeInternalValuesParams​

MakeInternalValuesParams: object | object | object

MessageImprintParameters​

MessageImprintParameters: PkiObjectParameters & Partial<IMessageImprint>

MessageImprintSchema​

MessageImprintSchema: SchemaParameters<object>

Type declaration​

hashAlgorithm?​

optional hashAlgorithm: AlgorithmIdentifierSchema

hashedMessage?​

optional hashedMessage: string

NameConstraintsParameters​

NameConstraintsParameters: PkiObjectParameters & Partial<INameConstraints>

ObjectDigestInfoParameters​

ObjectDigestInfoParameters: PkiObjectParameters & Partial<IObjectDigestInfo>

OCSPRequestParameters​

OCSPRequestParameters: PkiObjectParameters & Partial<IOCSPRequest>

OCSPResponseParameters​

OCSPResponseParameters: PkiObjectParameters & Partial<IOCSPResponse>

OriginatorIdentifierOrKeyParameters​

OriginatorIdentifierOrKeyParameters: PkiObjectParameters & Partial<IOriginatorIdentifierOrKey>

OriginatorIdentifierOrKeySchema​

OriginatorIdentifierOrKeySchema: SchemaParameters

OriginatorInfoParameters​

OriginatorInfoParameters: PkiObjectParameters & Partial<IOriginatorInfo>

OriginatorPublicKeyParameters​

OriginatorPublicKeyParameters: PkiObjectParameters & Partial<IOriginatorPublicKey>

OtherCertificateFormatParameters​

OtherCertificateFormatParameters: PkiObjectParameters & Partial<IOtherCertificateFormat>

OtherKeyAttributeParameters​

OtherKeyAttributeParameters: PkiObjectParameters & Partial<IOtherKeyAttribute>

OtherKeyAttributeSchema​

OtherKeyAttributeSchema: SchemaType

OtherPrimeInfoParameters​

OtherPrimeInfoParameters: PkiObjectParameters & Partial<IOtherPrimeInfo> & object

Type declaration​

json?​

optional json: OtherPrimeInfoJson

OtherPrimeInfoSchema​

OtherPrimeInfoSchema: SchemaParameters<object>

Type declaration​

coefficient?​

optional coefficient: string

exponent?​

optional exponent: string

prime?​

optional prime: string

OtherRecipientInfoParameters​

OtherRecipientInfoParameters: PkiObjectParameters & Partial<IOtherRecipientInfo>

OtherRevocationInfoFormatParameters​

OtherRevocationInfoFormatParameters: PkiObjectParameters & Partial<IOtherRevocationInfoFormat>

PasswordRecipientinfoParameters​

PasswordRecipientinfoParameters: PkiObjectParameters & Partial<IPasswordRecipientInfo>

PBES2ParamsParameters​

PBES2ParamsParameters: PkiObjectParameters & Partial<IPBES2Params>

PBKDF2ParamsParameters​

PBKDF2ParamsParameters: PkiObjectParameters & Partial<IPBKDF2Params>

PFXParameters​

PFXParameters: PkiObjectParameters & Partial<IPFX>

PKCS8ShroudedKeyBagParameters​

PKCS8ShroudedKeyBagParameters: PkiObjectParameters & Partial<IPKCS8ShroudedKeyBag>

PKIStatusInfoParameters​

PKIStatusInfoParameters: PkiObjectParameters & Partial<IPKIStatusInfo>

PKIStatusInfoSchema​

PKIStatusInfoSchema: SchemaParameters<object>

Type declaration​

failInfo?​

optional failInfo: string

status?​

optional status: string

statusStrings?​

optional statusStrings: string

PolicyConstraintsParameters​

PolicyConstraintsParameters: PkiObjectParameters & Partial<IPolicyConstraints>

PolicyInformationParameters​

PolicyInformationParameters: PkiObjectParameters & Partial<IPolicyInformation>

PolicyMappingParameters​

PolicyMappingParameters: PkiObjectParameters & Partial<IPolicyMapping>

PolicyMappingsParameters​

PolicyMappingsParameters: PkiObjectParameters & Partial<IPolicyMappings>

PolicyQualifierInfoParameters​

PolicyQualifierInfoParameters: PkiObjectParameters & Partial<IPolicyQualifierInfo>

PrivateKeyInfoParameters​

PrivateKeyInfoParameters: PkiObjectParameters & Partial<IPrivateKeyInfo> & object

Type declaration​

json?​

optional json: JsonWebKey

PrivateKeyUsagePeriodParameters​

PrivateKeyUsagePeriodParameters: PkiObjectParameters & Partial<IPrivateKeyUsagePeriod>

PublicKeyInfoParameters​

PublicKeyInfoParameters: PkiObjectParameters & Partial<IPublicKeyInfo> & object

Type declaration​

json?​

optional json: JsonWebKey

PublicKeyInfoSchema​

PublicKeyInfoSchema: SchemaParameters<object>

Type declaration​

algorithm?​

optional algorithm: AlgorithmIdentifierSchema

subjectPublicKey?​

optional subjectPublicKey: string

QCStatementParameters​

QCStatementParameters: PkiObjectParameters & Partial<IQCStatement>

QCStatementSchema​

QCStatementSchema: SchemaParameters<object>

Type declaration​

id?​

optional id: string

type?​

optional type: string

QCStatementsParameters​

QCStatementsParameters: PkiObjectParameters & Partial<IQCStatements>

RecipientEncryptedKeyParameters​

RecipientEncryptedKeyParameters: PkiObjectParameters & Partial<IRecipientEncryptedKey>

RecipientEncryptedKeysParameters​

RecipientEncryptedKeysParameters: PkiObjectParameters & Partial<IRecipientEncryptedKeys>

RecipientEncryptedKeysSchema​

RecipientEncryptedKeysSchema: SchemaParameters<object>

Type declaration​

RecipientEncryptedKeys?​

optional RecipientEncryptedKeys: string

RecipientIdentifierMixedJson​

RecipientIdentifierMixedJson: IssuerAndSerialNumberJson | asn1js.OctetStringJson

RecipientIdentifierParameters​

RecipientIdentifierParameters: PkiObjectParameters & Partial<IRecipientIdentifier>

RecipientIdentifierSchema​

RecipientIdentifierSchema: SchemaParameters

RecipientIdentifierType​

RecipientIdentifierType: IssuerAndSerialNumber | asn1js.OctetString

RecipientInfoParameters​

RecipientInfoParameters: PkiObjectParameters & Partial<IRecipientInfo>

RecipientInfoValue​

RecipientInfoValue: KeyTransRecipientInfo | KeyAgreeRecipientInfo | KEKRecipientInfo | PasswordRecipientinfo | OtherRecipientInfo

RecipientInfoValueJson​

RecipientInfoValueJson: KeyTransRecipientInfoJson | KeyAgreeRecipientInfoJson | KEKRecipientInfoJson | PasswordRecipientInfoJson | OtherRecipientInfoJson

RecipientKeyIdentifierParameters​

RecipientKeyIdentifierParameters: PkiObjectParameters & Partial<IRecipientKeyIdentifier>

RecipientKeyIdentifierSchema​

RecipientKeyIdentifierSchema: SchemaParameters<object>

Type declaration​

date?​

optional date: string

other?​

optional other: OtherKeyAttributeSchema

subjectKeyIdentifier?​

optional subjectKeyIdentifier: string

RelativeDistinguishedNamesParameters​

RelativeDistinguishedNamesParameters: PkiObjectParameters & Partial<IRelativeDistinguishedNames>

RelativeDistinguishedNamesSchema​

RelativeDistinguishedNamesSchema: SchemaParameters<object>

Type declaration​

repeatedSequence?​

optional repeatedSequence: string

repeatedSet?​

optional repeatedSet: string

typeAndValue?​

optional typeAndValue: SchemaType

RequestParameters​

RequestParameters: PkiObjectParameters & Partial<IRequest>

RequestSchema​

RequestSchema: SchemaParameters<object>

Type declaration​

extensions?​

optional extensions: ExtensionSchema

reqCert?​

optional reqCert: CertIDSchema

singleRequestExtensions?​

optional singleRequestExtensions: string

ResponseBytesParameters​

ResponseBytesParameters: PkiObjectParameters & Partial<IResponseBytes>

ResponseBytesSchema​

ResponseBytesSchema: SchemaParameters<object>

Type declaration​

response?​

optional response: string

responseType?​

optional responseType: string

ResponseDataParameters​

ResponseDataParameters: PkiObjectParameters & Partial<IResponseData>

ResponseDataSchema​

ResponseDataSchema: SchemaParameters<object>

Type declaration​

extensions?​

optional extensions: ExtensionsSchema

producedAt?​

optional producedAt: string

responderID?​

optional responderID: string

response?​

optional response: SingleResponseSchema

ResponseDataByKey?​

optional ResponseDataByKey: string

ResponseDataByName?​

optional ResponseDataByName: RelativeDistinguishedNamesSchema

version?​

optional version: string

RevocationInfoChoicesParameters​

RevocationInfoChoicesParameters: PkiObjectParameters & Partial<IRevocationInfoChoices>

RevocationInfoChoicesSchema​

RevocationInfoChoicesSchema: SchemaParameters<object>

Type declaration​

crls?​

optional crls: string

RevokedCertificateParameters​

RevokedCertificateParameters: PkiObjectParameters & Partial<IRevokedCertificate>

RSAESOAEPParamsParameters​

RSAESOAEPParamsParameters: PkiObjectParameters & Partial<IRSAESOAEPParams>

RSAPrivateKeyParameters​

RSAPrivateKeyParameters: PkiObjectParameters & Partial<IRSAPrivateKey> & object

Type declaration​

json?​

optional json: RSAPrivateKeyJson

RSAPublicKeyParameters​

RSAPublicKeyParameters: PkiObjectParameters & Partial<IRSAPublicKey> & object

Type declaration​

json?​

optional json: RSAPublicKeyJson

RSASSAPSSParamsParameters​

RSASSAPSSParamsParameters: PkiObjectParameters & Partial<IRSASSAPSSParams>

SafeBagParameters<T>​

SafeBagParameters<T>: PkiObjectParameters & Partial<ISafeBag<T>>

Type Parameters​

• T extends BagType = BagType

SafeContent​

SafeContent: ContentInfo | EncryptedData | EnvelopedData | object

SafeContentsParameters​

SafeContentsParameters: PkiObjectParameters & Partial<ISafeContents>

SchemaNames​

SchemaNames: object

Type declaration​

blockName?​

optional blockName: string

optional?​

optional optional: boolean

SchemaType​

SchemaType: any

SecretBagParameters​

SecretBagParameters: PkiObjectParameters & Partial<ISecretBag>

SignatureParameters​

SignatureParameters: PkiObjectParameters & Partial<ISignature>

SignatureSchema​

SignatureSchema: SchemaParameters<object>

Type declaration​

certs?​

optional certs: string

signature?​

optional signature: string

signatureAlgorithm?​

optional signatureAlgorithm: AlgorithmIdentifierSchema

SignedAndUnsignedAttributesParameters​

SignedAndUnsignedAttributesParameters: PkiObjectParameters & Partial<ISignedAndUnsignedAttributes>

SignedAndUnsignedAttributesSchema​

SignedAndUnsignedAttributesSchema: SchemaParameters<object>

Type declaration​

attributes?​

optional attributes: string

tagNumber?​

optional tagNumber: number

SignedCertificateTimestampListParameters​

SignedCertificateTimestampListParameters: PkiObjectParameters & Partial<ISignedCertificateTimestampList>

SignedCertificateTimestampParameters​

SignedCertificateTimestampParameters: PkiObjectParameters & Partial<ISignedCertificateTimestamp> & object

Type declaration​

stream?​

optional stream: bs.SeqStream

SignedDataCRL​

SignedDataCRL: CertificateRevocationList | OtherRevocationInfoFormat

SignedDataCRLJson​

SignedDataCRLJson: CertificateRevocationListJson | OtherRevocationInfoFormatJson

SignedDataParameters​

SignedDataParameters: PkiObjectParameters & Partial<ISignedData>

SignerInfoParameters​

SignerInfoParameters: PkiObjectParameters & Partial<ISignerInfo>

SingleResponseParameters​

SingleResponseParameters: PkiObjectParameters & Partial<ISingleResponse>

SingleResponseSchema​

SingleResponseSchema: SchemaParameters<object>

Type declaration​

certID?​

optional certID: CertIDSchema

certStatus?​

optional certStatus: string

nextUpdate?​

optional nextUpdate: string

singleExtensions?​

optional singleExtensions: ExtensionsSchema

thisUpdate?​

optional thisUpdate: string

SubjectDirectoryAttributesParameters​

SubjectDirectoryAttributesParameters: PkiObjectParameters & Partial<ISubjectDirectoryAttributes>

TBSCertificateSchema​

TBSCertificateSchema: SchemaParameters<object>

Type declaration​

extensions?​

optional extensions: ExtensionsSchema

issuer?​

optional issuer: RelativeDistinguishedNamesSchema

notAfter?​

optional notAfter: TimeSchema

notBefore?​

optional notBefore: TimeSchema

signature?​

optional signature: AlgorithmIdentifierSchema

subject?​

optional subject: RelativeDistinguishedNamesSchema

subjectPublicKeyInfo?​

optional subjectPublicKeyInfo: PublicKeyInfoSchema

tbsCertificateIssuerUniqueID?​

optional tbsCertificateIssuerUniqueID: string

tbsCertificateSerialNumber?​

optional tbsCertificateSerialNumber: string

tbsCertificateSubjectUniqueID?​

optional tbsCertificateSubjectUniqueID: string

tbsCertificateValidity?​

optional tbsCertificateValidity: string

tbsCertificateVersion?​

optional tbsCertificateVersion: string

TBSCertListSchema​

TBSCertListSchema: SchemaParameters<object>

Type declaration​

crlExtensions?​

optional crlExtensions: ExtensionsSchema

issuer?​

optional issuer: RelativeDistinguishedNamesSchema

signature?​

optional signature: AlgorithmIdentifierSchema

tbsCertListNextUpdate?​

optional tbsCertListNextUpdate: TimeSchema

tbsCertListRevokedCertificates?​

optional tbsCertListRevokedCertificates: string

tbsCertListThisUpdate?​

optional tbsCertListThisUpdate: TimeSchema

tbsCertListVersion?​

optional tbsCertListVersion: string

TBSRequestParameters​

TBSRequestParameters: PkiObjectParameters & Partial<ITBSRequest>

TBSRequestSchema​

TBSRequestSchema: SchemaParameters<object>

Type declaration​

extensions?​

optional extensions: ExtensionsSchema

requestExtensions?​

optional requestExtensions: string

requestList?​

optional requestList: string

requestNames?​

optional requestNames: RequestSchema

requestorName?​

optional requestorName: GeneralNameSchema

requests?​

optional requests: string

TBSRequestVersion?​

optional TBSRequestVersion: string

TimeParameters​

TimeParameters: PkiObjectParameters & Partial<ITime>

TimeSchema​

TimeSchema: SchemaParameters<object>

Type declaration​

generalTimeName?​

optional generalTimeName: string

utcTimeName?​

optional utcTimeName: string

TimeStampReqParameters​

TimeStampReqParameters: PkiObjectParameters & Partial<ITimeStampReq>

TimeStampRespParameters​

TimeStampRespParameters: PkiObjectParameters & Partial<ITimeStampResp>

TSTInfoParameters​

TSTInfoParameters: PkiObjectParameters & Partial<ITSTInfo>

V2FormParameters​

V2FormParameters: PkiObjectParameters & Partial<IV2Form>

Variables​

engine​

engine: GlobalCryptoEngine

HASH_ALGORITHM​

const HASH_ALGORITHM: "hashAlgorithm" = "hashAlgorithm"

HASHED_MESSAGE​

const HASHED_MESSAGE: "hashedMessage" = "hashedMessage"

id_ad​

const id_ad: "1.3.6.1.5.5.7.48"

id_ad_caIssuers​

const id_ad_caIssuers: "1.3.6.1.5.5.7.48.2"

id_ad_ocsp​

const id_ad_ocsp: "1.3.6.1.5.5.7.48.1"

id_AnyPolicy​

const id_AnyPolicy: "2.5.29.32.0" = "2.5.29.32.0"

id_AuthorityInfoAccess​

const id_AuthorityInfoAccess: "1.3.6.1.5.5.7.1.1" = "1.3.6.1.5.5.7.1.1"

id_AuthorityKeyIdentifier​

const id_AuthorityKeyIdentifier: "2.5.29.35" = "2.5.29.35"

id_BaseCRLNumber​

const id_BaseCRLNumber: "2.5.29.27" = "2.5.29.27"

id_BasicConstraints​

const id_BasicConstraints: "2.5.29.19" = "2.5.29.19"

id_CertBag_AttributeCertificate​

const id_CertBag_AttributeCertificate: "1.2.840.113549.1.9.22.3" = "1.2.840.113549.1.9.22.3"

id_CertBag_SDSICertificate​

const id_CertBag_SDSICertificate: "1.2.840.113549.1.9.22.2" = "1.2.840.113549.1.9.22.2"

id_CertBag_X509Certificate​

const id_CertBag_X509Certificate: "1.2.840.113549.1.9.22.1" = "1.2.840.113549.1.9.22.1"

id_CertificateIssuer​

const id_CertificateIssuer: "2.5.29.29" = "2.5.29.29"

id_CertificatePolicies​

const id_CertificatePolicies: "2.5.29.32" = "2.5.29.32"

id_ContentType_Data​

const id_ContentType_Data: "1.2.840.113549.1.7.1" = "1.2.840.113549.1.7.1"

id_ContentType_EncryptedData​

const id_ContentType_EncryptedData: "1.2.840.113549.1.7.6" = "1.2.840.113549.1.7.6"

id_ContentType_EnvelopedData​

const id_ContentType_EnvelopedData: "1.2.840.113549.1.7.3" = "1.2.840.113549.1.7.3"

id_ContentType_SignedData​

const id_ContentType_SignedData: "1.2.840.113549.1.7.2" = "1.2.840.113549.1.7.2"

id_CRLBag_X509CRL​

const id_CRLBag_X509CRL: "1.2.840.113549.1.9.23.1" = "1.2.840.113549.1.9.23.1"

id_CRLDistributionPoints​

const id_CRLDistributionPoints: "2.5.29.31" = "2.5.29.31"

id_CRLNumber​

const id_CRLNumber: "2.5.29.20" = "2.5.29.20"

id_CRLReason​

const id_CRLReason: "2.5.29.21" = "2.5.29.21"

id_eContentType_TSTInfo​

const id_eContentType_TSTInfo: "1.2.840.113549.1.9.16.1.4" = "1.2.840.113549.1.9.16.1.4"

id_ExtKeyUsage​

const id_ExtKeyUsage: "2.5.29.37" = "2.5.29.37"

id_FreshestCRL​

const id_FreshestCRL: "2.5.29.46" = "2.5.29.46"

id_InhibitAnyPolicy​

const id_InhibitAnyPolicy: "2.5.29.54" = "2.5.29.54"

id_InvalidityDate​

const id_InvalidityDate: "2.5.29.24" = "2.5.29.24"

id_IssuerAltName​

const id_IssuerAltName: "2.5.29.18" = "2.5.29.18"

id_IssuingDistributionPoint​

const id_IssuingDistributionPoint: "2.5.29.28" = "2.5.29.28"

id_KeyUsage​

const id_KeyUsage: "2.5.29.15" = "2.5.29.15"

id_MicrosoftAppPolicies​

const id_MicrosoftAppPolicies: "1.3.6.1.4.1.311.21.10" = "1.3.6.1.4.1.311.21.10"

id_MicrosoftCaVersion​

const id_MicrosoftCaVersion: "1.3.6.1.4.1.311.21.1" = "1.3.6.1.4.1.311.21.1"

id_MicrosoftCertTemplateV1​

const id_MicrosoftCertTemplateV1: "1.3.6.1.4.1.311.20.2" = "1.3.6.1.4.1.311.20.2"

id_MicrosoftCertTemplateV2​

const id_MicrosoftCertTemplateV2: "1.3.6.1.4.1.311.21.7" = "1.3.6.1.4.1.311.21.7"

id_MicrosoftPrevCaCertHash​

const id_MicrosoftPrevCaCertHash: "1.3.6.1.4.1.311.21.2" = "1.3.6.1.4.1.311.21.2"

id_NameConstraints​

const id_NameConstraints: "2.5.29.30" = "2.5.29.30"

id_pkix​

const id_pkix: "1.3.6.1.5.5.7" = "1.3.6.1.5.5.7"

id_PKIX_OCSP_Basic​

const id_PKIX_OCSP_Basic: "1.3.6.1.5.5.7.48.1.1"

id_PolicyConstraints​

const id_PolicyConstraints: "2.5.29.36" = "2.5.29.36"

id_PolicyMappings​

const id_PolicyMappings: "2.5.29.33" = "2.5.29.33"

id_PrivateKeyUsagePeriod​

const id_PrivateKeyUsagePeriod: "2.5.29.16" = "2.5.29.16"

id_QCStatements​

const id_QCStatements: "1.3.6.1.5.5.7.1.3" = "1.3.6.1.5.5.7.1.3"

id_sha1​

const id_sha1: "1.3.14.3.2.26" = "1.3.14.3.2.26"

id_sha256​

const id_sha256: "2.16.840.1.101.3.4.2.1" = "2.16.840.1.101.3.4.2.1"

id_sha384​

const id_sha384: "2.16.840.1.101.3.4.2.2" = "2.16.840.1.101.3.4.2.2"

id_sha512​

const id_sha512: "2.16.840.1.101.3.4.2.3" = "2.16.840.1.101.3.4.2.3"

id_SignedCertificateTimestampList​

const id_SignedCertificateTimestampList: "1.3.6.1.4.1.11129.2.4.2" = "1.3.6.1.4.1.11129.2.4.2"

id_SubjectAltName​

const id_SubjectAltName: "2.5.29.17" = "2.5.29.17"

id_SubjectDirectoryAttributes​

const id_SubjectDirectoryAttributes: "2.5.29.9" = "2.5.29.9"

id_SubjectInfoAccess​

const id_SubjectInfoAccess: "1.3.6.1.5.5.7.1.11" = "1.3.6.1.5.5.7.1.11"

id_SubjectKeyIdentifier​

const id_SubjectKeyIdentifier: "2.5.29.14" = "2.5.29.14"

MICROS​

const MICROS: "micros" = "micros"

MILLIS​

const MILLIS: "millis" = "millis"

POLICY_IDENTIFIER​

const POLICY_IDENTIFIER: "policyIdentifier" = "policyIdentifier"

POLICY_QUALIFIERS​

const POLICY_QUALIFIERS: "policyQualifiers" = "policyQualifiers"

RDN​

const RDN: "RDN" = "RDN"

SECONDS​

const SECONDS: "seconds" = "seconds"

TYPE​

const TYPE: "type" = "type"

TYPE_AND_VALUES​

const TYPE_AND_VALUES: "typesAndValues" = "typesAndValues"

VALUE​

const VALUE: "value" = "value"

VALUE_BEFORE_DECODE​

const VALUE_BEFORE_DECODE: "valueBeforeDecode" = "valueBeforeDecode"

Functions​

checkCA()​

checkCA(cert, signerCert): Certificate | null

Check CA flag for the certificate

Parameters​

• cert: Certificate

Certificate to find CA flag for

• signerCert: null | Certificate = null

Returns​

Certificate | null

Returns Certificate if cert is CA certificate otherwise return null

createCMSECDSASignature()​

createCMSECDSASignature(signatureBuffer): ArrayBuffer

Create CMS ECDSA signature from WebCrypto ECDSA signature

Parameters​

• signatureBuffer: ArrayBuffer

WebCrypto result of "sign" function

Returns​

ArrayBuffer

createECDSASignatureFromCMS()​

createECDSASignatureFromCMS(cmsSignature, pointSize): ArrayBuffer

Create a single ArrayBuffer from CMS ECDSA signature

Parameters​

• cmsSignature: AsnType

ASN.1 SEQUENCE contains CMS ECDSA signature

• pointSize: number

Size of EC point. Use ECNamedCurves.find to get correct point size

Returns​

ArrayBuffer

WebCrypto signature

getAlgorithmByOID()​

getAlgorithmByOID(oid, safety, target)​

getAlgorithmByOID<T>(oid, safety?, target?): T | object

Gets WebCrypto algorithm by well-known OID

Type Parameters​

• T extends Algorithm = Algorithm

Parameters​

• oid: string

algorithm identifier

• safety?: boolean

if true throws exception on unknown algorithm identifier

• target?: string

name of the target

Returns​

T | object

WebCrypto algorithm or an empty object

getAlgorithmByOID(oid, safety, target)​

getAlgorithmByOID<T>(oid, safety, target?): T

Type Parameters​

• T extends Algorithm = Algorithm

Parameters​

• oid: string

• safety: true

• target?: string

Returns​

T

getAlgorithmParameters()​

getAlgorithmParameters(algorithmName, operation): CryptoEngineAlgorithmParams

Get default algorithm parameters for each kind of operation

Parameters​

• algorithmName: string

Algorithm name to get common parameters for

• operation: CryptoEngineAlgorithmOperation

Kind of operation: "sign", "encrypt", "generateKey", "importKey", "exportKey", "verify"

Returns​

CryptoEngineAlgorithmParams

getCrypto()​

getCrypto(safety)​

getCrypto(safety?): ICryptoEngine | null

Gets crypto subtle from the current "crypto engine"

Parameters​

• safety?: boolean

Returns​

ICryptoEngine | null

Reruns ICryptoEngine or null

getCrypto(safety)​

getCrypto(safety): ICryptoEngine

Gets crypto subtle from the current "crypto engine"

Parameters​

• safety: true

Returns​

ICryptoEngine

Reruns ICryptoEngine or throws en exception

Throws​

Throws Error if subtle is empty

getEngine()​

getEngine(): GlobalCryptoEngine

Returns​

GlobalCryptoEngine

getHashAlgorithm()​

getHashAlgorithm(signatureAlgorithm): string

Getting hash algorithm by signature algorithm

Parameters​

• signatureAlgorithm: AlgorithmIdentifier

Signature algorithm

Returns​

string

getOIDByAlgorithm()​

getOIDByAlgorithm(algorithm, safety?, target?): string

Get OID for each specific algorithm

Parameters​

• algorithm: Algorithm

WebCrypto Algorithm

• safety?: boolean

if true throws exception on unknown algorithm

• target?: string

name of the target

Returns​

string

Throws​

Throws Error exception if unknown WebCrypto algorithm

getRandomValues()​

getRandomValues(view): Uint8Array

Initialize input Uint8Array by random values (with help from current "crypto engine")

Parameters​

• view: Uint8Array

Returns​

Uint8Array

kdf()​

kdf(hashFunction, Zbuffer, keydatalen, SharedInfo, crypto): Promise<ArrayBuffer>

ANS X9.63 Key Derivation Function

Parameters​

• hashFunction: string

Used hash function

• Zbuffer: ArrayBuffer

ArrayBuffer containing ECDH shared secret to derive from

• keydatalen: number

Length (!!! in BITS !!!) of used kew derivation function

• SharedInfo: ArrayBuffer

Usually DER encoded "ECC_CMS_SharedInfo" structure

• crypto: ICryptoEngine = ...

Crypto engine

Returns​

Promise<ArrayBuffer>

setEngine()​

setEngine(name, crypto, subtle)​

setEngine(name, crypto, subtle): void

Sets global crypto engine

Parameters​

• name: string

Name of the crypto engine

• crypto: Crypto | ICryptoEngine

• subtle: SubtleCrypto | ICryptoEngine

Returns​

void

Deprecated​

Since version 3.0.0

setEngine(name, crypto)​

setEngine(name, crypto?): void

Sets global crypto engine

Parameters​

• name: string

Name of the crypto engine

• crypto?: ICryptoEngine

Crypto engine. If the parameter is omitted, CryptoEngine with self.crypto are used

Returns​

void

Since​

3.0.0

stringPrep()​

stringPrep(inputString): string

String preparation function. In a future here will be realization of algorithm from RFC4518

Parameters​

• inputString: string

JavaScript string. As soon as for each ASN.1 string type we have a specific transformation function here we will work with pure JavaScript string

Returns​

string

Formatted string

verifySCTsForCertificate()​

verifySCTsForCertificate(certificate, issuerCertificate, logs, index, crypto): Promise<boolean[]>

Verify SignedCertificateTimestamp for specific certificate content

Parameters​

• certificate: Certificate

Certificate for which verification would be performed

• issuerCertificate: Certificate

Certificate of the issuer of target certificate

• logs: Log[]

Array of objects with information about each CT Log (like here: https://ct.grahamedgecombe.com/logs.json)

• index: number = ...

Index of SignedCertificateTimestamp inside SignedCertificateTimestampList (for -1 would verify all)

• crypto: ICryptoEngine = ...

Crypto engine

Returns​

Promise<boolean[]>

Array of verification results

Enumerations​

Classes​

Interfaces​