Skip to main content

pkijs

Enumerations​

Classes​

Interfaces​

Type Aliases​

AccessDescriptionParameters​

Ƭ AccessDescriptionParameters: PkiObjectParameters & Partial<IAccessDescription>

AccuracyParameters​

Ƭ AccuracyParameters: PkiObjectParameters & Partial<IAccuracy>

AccuracySchema​

Ƭ AccuracySchema: SchemaParameters<{ micros?: string ; millis?: string ; seconds?: string }>

AlgorithmIdentifierParameters​

Ƭ AlgorithmIdentifierParameters: PkiObjectParameters & Partial<IAlgorithmIdentifier>

AlgorithmIdentifierSchema​

Ƭ AlgorithmIdentifierSchema: SchemaParameters<{ algorithmIdentifier?: string ; 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<{ notAfterTime?: string ; notBeforeTime?: string }>

AttributeCertificateInfoV1Parameters​

Ƭ AttributeCertificateInfoV1Parameters: PkiObjectParameters & Partial<IAttributeCertificateInfoV1>

AttributeCertificateInfoV1Schema​

Ƭ AttributeCertificateInfoV1Schema: SchemaParameters<{ attrCertValidityPeriod?: AttCertValidityPeriodSchema ; attributes?: string ; baseCertificateID?: string ; extensions?: ExtensionsSchema ; issuer?: string ; issuerUniqueID?: string ; serialNumber?: string ; signature?: AlgorithmIdentifierSchema ; subjectName?: string ; version?: string }>

AttributeCertificateInfoV2Parameters​

Ƭ AttributeCertificateInfoV2Parameters: PkiObjectParameters & Partial<AttributeCertificateInfoV2>

AttributeCertificateInfoV2Schema​

Ƭ AttributeCertificateInfoV2Schema: SchemaParameters<{ attrCertValidityPeriod?: AttCertValidityPeriodSchema ; attributes?: string ; extensions?: ExtensionsSchema ; holder?: HolderSchema ; issuer?: string ; issuerUniqueID?: string ; serialNumber?: string ; signature?: AlgorithmIdentifierSchema ; version?: string }>

AttributeCertificateV1Parameters​

Ƭ AttributeCertificateV1Parameters: PkiObjectParameters & Partial<IAttributeCertificateV1>

AttributeCertificateV2Parameters​

Ƭ AttributeCertificateV2Parameters: PkiObjectParameters & Partial<IAttributeCertificateV2>

AttributeParameters​

Ƭ AttributeParameters: PkiObjectParameters & Partial<IAttribute>

AttributeSchema​

Ƭ AttributeSchema: SchemaParameters<{ setName?: string ; type?: string ; 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>

CRLBagParameters​

Ƭ CRLBagParameters: PkiObjectParameters & Partial<ICRLBag>

CRLDistributionPointsParameters​

Ƭ CRLDistributionPointsParameters: PkiObjectParameters & Partial<ICRLDistributionPoints>

CertBagParameters​

Ƭ CertBagParameters: PkiObjectParameters & Partial<ICertBag>

CertIDParameters​

Ƭ CertIDParameters: PkiObjectParameters & Partial<ICertID>

CertIDSchema​

Ƭ CertIDSchema: SchemaParameters<{ hashAlgorithm?: string ; hashAlgorithmObject?: AlgorithmIdentifierSchema ; issuerKeyHash?: string ; issuerNameHash?: string ; 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<{ signatureAlgorithm?: AlgorithmIdentifierSchema ; signatureValue?: string ; tbsCertificate?: TBSCertificateSchema }>

Parameters for Certificate schema generation

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<{ content?: string ; contentType?: string }>

CryptoEngineAlgorithmOperation​

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

DigestInfoParameters​

Ƭ DigestInfoParameters: PkiObjectParameters & Partial<IDigestInfo>

DigestInfoSchema​

Ƭ DigestInfoSchema: SchemaParameters<{ digest?: string ; 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> & { json?: ECPrivateKeyJson }

ECPublicKeyParameters​

Ƭ ECPublicKeyParameters: PkiObjectParameters & Partial<IECPublicKey> & { json?: ECPublicKeyJson }

EncapsulatedContentInfoParameters​

Ƭ EncapsulatedContentInfoParameters: PkiObjectParameters & Partial<IEncapsulatedContentInfo>

EncapsulatedContentInfoSchema​

Ƭ EncapsulatedContentInfoSchema: SchemaParameters<{ eContent?: string ; eContentType?: string }>

EncryptedContentInfoSchema​

Ƭ EncryptedContentInfoSchema: SchemaParameters<{ contentEncryptionAlgorithm?: AlgorithmIdentifierSchema ; contentType?: string ; 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

ExtKeyUsageParameters​

Ƭ ExtKeyUsageParameters: PkiObjectParameters & Partial<IExtKeyUsage>

ExtensionParameters​

Ƭ ExtensionParameters: PkiObjectParameters & ExtensionConstructorParameters

ExtensionParsedValue​

Ƭ ExtensionParsedValue: SchemaCompatible & { parsingError?: string } | SchemaType

ExtensionSchema​

Ƭ ExtensionSchema: SchemaParameters<{ critical?: string ; extnID?: string ; extnValue?: string }>

ExtensionsParameters​

Ƭ ExtensionsParameters: PkiObjectParameters & Partial<IExtensions>

ExtensionsSchema​

Ƭ ExtensionsSchema: SchemaParameters<{ extension?: ExtensionSchema ; extensions?: string }>

FindIssuerCallback​

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

Type declaration​

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

Parameters​
NameType
certificateCertificate
validationEngineCertificateChainValidationEngine
crypto?ICryptoEngine
Returns​

Promise<Certificate[]>

FindOriginCallback​

Ƭ FindOriginCallback: (certificate: Certificate, validationEngine: CertificateChainValidationEngine) => string

Type declaration​

▸ (certificate, validationEngine): string

Parameters​
NameType
certificateCertificate
validationEngineCertificateChainValidationEngine
Returns​

string

GeneralNameParameters​

Ƭ GeneralNameParameters: PkiObjectParameters & Partial<{ type: 1 | 2 | 6 ; value: string } | { type: 0 | 3 | 4 | 7 | 8 ; value: any }>

GeneralNamesParameters​

Ƭ GeneralNamesParameters: PkiObjectParameters & Partial<IGeneralNames>

GeneralNamesSchema​

Ƭ GeneralNamesSchema: SchemaParameters<{ generalNames?: string }>

GeneralSubtreeParameters​

Ƭ GeneralSubtreeParameters: PkiObjectParameters & Partial<IGeneralSubtree>

HolderParameters​

Ƭ HolderParameters: PkiObjectParameters & Partial<IHolder>

HolderSchema​

Ƭ HolderSchema: SchemaParameters<{ baseCertificateID?: string ; entityName?: string ; objectDigestInfo?: string }>

InfoAccessParameters​

Ƭ InfoAccessParameters: PkiObjectParameters & Partial<IInfoAccess>

IssuerAndSerialNumberParameters​

Ƭ IssuerAndSerialNumberParameters: PkiObjectParameters & Partial<IIssuerAndSerialNumber>

IssuerAndSerialNumberSchema​

Ƭ IssuerAndSerialNumberSchema: SchemaParameters<{ issuer?: RelativeDistinguishedNamesSchema ; serialNumber?: string }>

IssuerSerialParameters​

Ƭ IssuerSerialParameters: PkiObjectParameters & Partial<IIssuerSerial>

IssuingDistributionPointParameters​

Ƭ IssuingDistributionPointParameters: PkiObjectParameters & Partial<IIssuingDistributionPoint>

KEKIdentifierParameters​

Ƭ KEKIdentifierParameters: PkiObjectParameters & Partial<IKEKIdentifier>

KEKIdentifierSchema​

Ƭ KEKIdentifierSchema: SchemaParameters<{ date?: string ; keyIdentifier?: string ; other?: OtherKeyAttributeSchema }>

KEKRecipientInfoParameters​

Ƭ KEKRecipientInfoParameters: PkiObjectParameters & Partial<IKEKRecipientInfo>

KeyAgreeRecipientIdentifierParameters​

Ƭ KeyAgreeRecipientIdentifierParameters: PkiObjectParameters & Partial<IKeyAgreeRecipientIdentifier>

KeyAgreeRecipientIdentifierSchema​

Ƭ KeyAgreeRecipientIdentifierSchema: SchemaParameters<{ issuerAndSerialNumber?: IssuerAndSerialNumberSchema ; rKeyId?: RecipientKeyIdentifierSchema }>

KeyAgreeRecipientInfoParameters​

Ƭ KeyAgreeRecipientInfoParameters: PkiObjectParameters & Partial<IKeyAgreeRecipientInfo>

KeyTransRecipientInfoParameters​

Ƭ KeyTransRecipientInfoParameters: PkiObjectParameters & Partial<IKeyTransRecipientInfo>

MacDataParameters​

Ƭ MacDataParameters: PkiObjectParameters & Partial<IMacData>

MacDataSchema​

Ƭ MacDataSchema: SchemaParameters<{ iterations?: string ; mac?: DigestInfoSchema ; macSalt?: string }>

MakeInternalValuesParams​

Ƭ MakeInternalValuesParams: | { hmacHashAlgorithm: string ; iterations: number ; password: ArrayBuffer ; pbkdf2HashAlgorithm: Algorithm } | { hashAlgorithm: string ; privateKey: CryptoKey ; signingCertificate: Certificate }

MessageImprintParameters​

Ƭ MessageImprintParameters: PkiObjectParameters & Partial<IMessageImprint>

MessageImprintSchema​

Ƭ MessageImprintSchema: SchemaParameters<{ hashAlgorithm?: AlgorithmIdentifierSchema ; hashedMessage?: string }>

NameConstraintsParameters​

Ƭ NameConstraintsParameters: PkiObjectParameters & Partial<INameConstraints>

OCSPRequestParameters​

Ƭ OCSPRequestParameters: PkiObjectParameters & Partial<IOCSPRequest>

OCSPResponseParameters​

Ƭ OCSPResponseParameters: PkiObjectParameters & Partial<IOCSPResponse>

ObjectDigestInfoParameters​

Ƭ ObjectDigestInfoParameters: PkiObjectParameters & Partial<IObjectDigestInfo>

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> & { json?: OtherPrimeInfoJson }

OtherPrimeInfoSchema​

Ƭ OtherPrimeInfoSchema: SchemaParameters<{ coefficient?: string ; exponent?: string ; prime?: string }>

OtherRecipientInfoParameters​

Ƭ OtherRecipientInfoParameters: PkiObjectParameters & Partial<IOtherRecipientInfo>

OtherRevocationInfoFormatParameters​

Ƭ OtherRevocationInfoFormatParameters: PkiObjectParameters & Partial<IOtherRevocationInfoFormat>

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<{ failInfo?: string ; status?: string ; statusStrings?: string }>

PasswordRecipientinfoParameters​

Ƭ PasswordRecipientinfoParameters: PkiObjectParameters & Partial<IPasswordRecipientInfo>

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> & { json?: JsonWebKey }

PrivateKeyUsagePeriodParameters​

Ƭ PrivateKeyUsagePeriodParameters: PkiObjectParameters & Partial<IPrivateKeyUsagePeriod>

PublicKeyInfoParameters​

Ƭ PublicKeyInfoParameters: PkiObjectParameters & Partial<IPublicKeyInfo> & { json?: JsonWebKey }

PublicKeyInfoSchema​

Ƭ PublicKeyInfoSchema: SchemaParameters<{ algorithm?: AlgorithmIdentifierSchema ; subjectPublicKey?: string }>

QCStatementParameters​

Ƭ QCStatementParameters: PkiObjectParameters & Partial<IQCStatement>

QCStatementSchema​

Ƭ QCStatementSchema: SchemaParameters<{ id?: string ; type?: string }>

QCStatementsParameters​

Ƭ QCStatementsParameters: PkiObjectParameters & Partial<IQCStatements>

RSAESOAEPParamsParameters​

Ƭ RSAESOAEPParamsParameters: PkiObjectParameters & Partial<IRSAESOAEPParams>

RSAPrivateKeyParameters​

Ƭ RSAPrivateKeyParameters: PkiObjectParameters & Partial<IRSAPrivateKey> & { json?: RSAPrivateKeyJson }

RSAPublicKeyParameters​

Ƭ RSAPublicKeyParameters: PkiObjectParameters & Partial<IRSAPublicKey> & { json?: RSAPublicKeyJson }

RSASSAPSSParamsParameters​

Ƭ RSASSAPSSParamsParameters: PkiObjectParameters & Partial<IRSASSAPSSParams>

RecipientEncryptedKeyParameters​

Ƭ RecipientEncryptedKeyParameters: PkiObjectParameters & Partial<IRecipientEncryptedKey>

RecipientEncryptedKeysParameters​

Ƭ RecipientEncryptedKeysParameters: PkiObjectParameters & Partial<IRecipientEncryptedKeys>

RecipientEncryptedKeysSchema​

Ƭ RecipientEncryptedKeysSchema: SchemaParameters<{ 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<{ date?: string ; other?: OtherKeyAttributeSchema ; subjectKeyIdentifier?: string }>

RelativeDistinguishedNamesParameters​

Ƭ RelativeDistinguishedNamesParameters: PkiObjectParameters & Partial<IRelativeDistinguishedNames>

RelativeDistinguishedNamesSchema​

Ƭ RelativeDistinguishedNamesSchema: SchemaParameters<{ repeatedSequence?: string ; repeatedSet?: string ; typeAndValue?: SchemaType }>

RequestParameters​

Ƭ RequestParameters: PkiObjectParameters & Partial<IRequest>

RequestSchema​

Ƭ RequestSchema: SchemaParameters<{ extensions?: ExtensionSchema ; reqCert?: CertIDSchema ; singleRequestExtensions?: string }>

ResponseBytesParameters​

Ƭ ResponseBytesParameters: PkiObjectParameters & Partial<IResponseBytes>

ResponseBytesSchema​

Ƭ ResponseBytesSchema: SchemaParameters<{ response?: string ; responseType?: string }>

ResponseDataParameters​

Ƭ ResponseDataParameters: PkiObjectParameters & Partial<IResponseData>

ResponseDataSchema​

Ƭ ResponseDataSchema: SchemaParameters<{ ResponseDataByKey?: string ; ResponseDataByName?: RelativeDistinguishedNamesSchema ; extensions?: ExtensionsSchema ; producedAt?: string ; responderID?: string ; response?: SingleResponseSchema ; version?: string }>

RevocationInfoChoicesParameters​

Ƭ RevocationInfoChoicesParameters: PkiObjectParameters & Partial<IRevocationInfoChoices>

RevocationInfoChoicesSchema​

Ƭ RevocationInfoChoicesSchema: SchemaParameters<{ crls?: string }>

RevokedCertificateParameters​

Ƭ RevokedCertificateParameters: PkiObjectParameters & Partial<IRevokedCertificate>

SafeBagParameters​

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

Type parameters​

NameType
Textends BagType = BagType

SafeContent​

Ƭ SafeContent: ContentInfo | EncryptedData | EnvelopedData | object

SafeContentsParameters​

Ƭ SafeContentsParameters: PkiObjectParameters & Partial<ISafeContents>

SchemaNames​

Ƭ SchemaNames: Object

Type declaration​

NameType
blockName?string
optional?boolean

SchemaType​

Ƭ SchemaType: any

SecretBagParameters​

Ƭ SecretBagParameters: PkiObjectParameters & Partial<ISecretBag>

SignatureParameters​

Ƭ SignatureParameters: PkiObjectParameters & Partial<ISignature>

SignatureSchema​

Ƭ SignatureSchema: SchemaParameters<{ certs?: string ; signature?: string ; signatureAlgorithm?: AlgorithmIdentifierSchema }>

SignedAndUnsignedAttributesParameters​

Ƭ SignedAndUnsignedAttributesParameters: PkiObjectParameters & Partial<ISignedAndUnsignedAttributes>

SignedAndUnsignedAttributesSchema​

Ƭ SignedAndUnsignedAttributesSchema: SchemaParameters<{ attributes?: string ; tagNumber?: number }>

SignedCertificateTimestampListParameters​

Ƭ SignedCertificateTimestampListParameters: PkiObjectParameters & Partial<ISignedCertificateTimestampList>

SignedCertificateTimestampParameters​

Ƭ SignedCertificateTimestampParameters: PkiObjectParameters & Partial<ISignedCertificateTimestamp> & { 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<{ certID?: CertIDSchema ; certStatus?: string ; nextUpdate?: string ; singleExtensions?: ExtensionsSchema ; thisUpdate?: string }>

SubjectDirectoryAttributesParameters​

Ƭ SubjectDirectoryAttributesParameters: PkiObjectParameters & Partial<ISubjectDirectoryAttributes>

TBSCertListSchema​

Ƭ TBSCertListSchema: SchemaParameters<{ crlExtensions?: ExtensionsSchema ; issuer?: RelativeDistinguishedNamesSchema ; signature?: AlgorithmIdentifierSchema ; tbsCertListNextUpdate?: TimeSchema ; tbsCertListRevokedCertificates?: string ; tbsCertListThisUpdate?: TimeSchema ; tbsCertListVersion?: string }>

TBSCertificateSchema​

Ƭ TBSCertificateSchema: SchemaParameters<{ extensions?: ExtensionsSchema ; issuer?: RelativeDistinguishedNamesSchema ; notAfter?: TimeSchema ; notBefore?: TimeSchema ; signature?: AlgorithmIdentifierSchema ; subject?: RelativeDistinguishedNamesSchema ; subjectPublicKeyInfo?: PublicKeyInfoSchema ; tbsCertificateIssuerUniqueID?: string ; tbsCertificateSerialNumber?: string ; tbsCertificateSubjectUniqueID?: string ; tbsCertificateValidity?: string ; tbsCertificateVersion?: string }>

TBSRequestParameters​

Ƭ TBSRequestParameters: PkiObjectParameters & Partial<ITBSRequest>

TBSRequestSchema​

Ƭ TBSRequestSchema: SchemaParameters<{ TBSRequestVersion?: string ; extensions?: ExtensionsSchema ; requestExtensions?: string ; requestList?: string ; requestNames?: RequestSchema ; requestorName?: GeneralNameSchema ; requests?: string }>

TSTInfoParameters​

Ƭ TSTInfoParameters: PkiObjectParameters & Partial<ITSTInfo>

TimeParameters​

Ƭ TimeParameters: PkiObjectParameters & Partial<ITime>

TimeSchema​

Ƭ TimeSchema: SchemaParameters<{ generalTimeName?: string ; utcTimeName?: string }>

TimeStampReqParameters​

Ƭ TimeStampReqParameters: PkiObjectParameters & Partial<ITimeStampReq>

TimeStampRespParameters​

Ƭ TimeStampRespParameters: PkiObjectParameters & Partial<ITimeStampResp>

V2FormParameters​

Ƭ V2FormParameters: PkiObjectParameters & Partial<IV2Form>

Variables​

HASHED_MESSAGE​

• Const HASHED_MESSAGE: "hashedMessage"

HASH_ALGORITHM​

• Const HASH_ALGORITHM: "hashAlgorithm"

MICROS​

• Const MICROS: "micros"

MILLIS​

• Const MILLIS: "millis"

POLICY_IDENTIFIER​

• Const POLICY_IDENTIFIER: "policyIdentifier"

POLICY_QUALIFIERS​

• Const POLICY_QUALIFIERS: "policyQualifiers"

RDN​

• Const RDN: "RDN"

SECONDS​

• Const SECONDS: "seconds"

TYPE​

• Const TYPE: "type"

TYPE_AND_VALUES​

• Const TYPE_AND_VALUES: "typesAndValues"

VALUE​

• Const VALUE: "value"

VALUE_BEFORE_DECODE​

• Const VALUE_BEFORE_DECODE: "valueBeforeDecode"

engine​

• engine: GlobalCryptoEngine

id_AnyPolicy​

• Const id_AnyPolicy: "2.5.29.32.0"

id_AuthorityInfoAccess​

• Const id_AuthorityInfoAccess: "1.3.6.1.5.5.7.1.1"

id_AuthorityKeyIdentifier​

• Const id_AuthorityKeyIdentifier: "2.5.29.35"

id_BaseCRLNumber​

• Const id_BaseCRLNumber: "2.5.29.27"

id_BasicConstraints​

• Const id_BasicConstraints: "2.5.29.19"

id_CRLBag_X509CRL​

• Const id_CRLBag_X509CRL: "1.2.840.113549.1.9.23.1"

id_CRLDistributionPoints​

• Const id_CRLDistributionPoints: "2.5.29.31"

id_CRLNumber​

• Const id_CRLNumber: "2.5.29.20"

id_CRLReason​

• Const id_CRLReason: "2.5.29.21"

id_CertBag_AttributeCertificate​

• Const id_CertBag_AttributeCertificate: "1.2.840.113549.1.9.22.3"

id_CertBag_SDSICertificate​

• Const id_CertBag_SDSICertificate: "1.2.840.113549.1.9.22.2"

id_CertBag_X509Certificate​

• Const id_CertBag_X509Certificate: "1.2.840.113549.1.9.22.1"

id_CertificateIssuer​

• Const id_CertificateIssuer: "2.5.29.29"

id_CertificatePolicies​

• Const id_CertificatePolicies: "2.5.29.32"

id_ContentType_Data​

• Const id_ContentType_Data: "1.2.840.113549.1.7.1"

id_ContentType_EncryptedData​

• Const id_ContentType_EncryptedData: "1.2.840.113549.1.7.6"

id_ContentType_EnvelopedData​

• Const id_ContentType_EnvelopedData: "1.2.840.113549.1.7.3"

id_ContentType_SignedData​

• Const id_ContentType_SignedData: "1.2.840.113549.1.7.2"

id_ExtKeyUsage​

• Const id_ExtKeyUsage: "2.5.29.37"

id_FreshestCRL​

• Const id_FreshestCRL: "2.5.29.46"

id_InhibitAnyPolicy​

• Const id_InhibitAnyPolicy: "2.5.29.54"

id_InvalidityDate​

• Const id_InvalidityDate: "2.5.29.24"

id_IssuerAltName​

• Const id_IssuerAltName: "2.5.29.18"

id_IssuingDistributionPoint​

• Const id_IssuingDistributionPoint: "2.5.29.28"

id_KeyUsage​

• Const id_KeyUsage: "2.5.29.15"

id_MicrosoftAppPolicies​

• Const id_MicrosoftAppPolicies: "1.3.6.1.4.1.311.21.10"

id_MicrosoftCaVersion​

• Const id_MicrosoftCaVersion: "1.3.6.1.4.1.311.21.1"

id_MicrosoftCertTemplateV1​

• Const id_MicrosoftCertTemplateV1: "1.3.6.1.4.1.311.20.2"

id_MicrosoftCertTemplateV2​

• Const id_MicrosoftCertTemplateV2: "1.3.6.1.4.1.311.21.7"

id_MicrosoftPrevCaCertHash​

• Const id_MicrosoftPrevCaCertHash: "1.3.6.1.4.1.311.21.2"

id_NameConstraints​

• Const id_NameConstraints: "2.5.29.30"

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"

id_PolicyMappings​

• Const id_PolicyMappings: "2.5.29.33"

id_PrivateKeyUsagePeriod​

• Const id_PrivateKeyUsagePeriod: "2.5.29.16"

id_QCStatements​

• Const id_QCStatements: "1.3.6.1.5.5.7.1.3"

id_SignedCertificateTimestampList​

• Const id_SignedCertificateTimestampList: "1.3.6.1.4.1.11129.2.4.2"

id_SubjectAltName​

• Const id_SubjectAltName: "2.5.29.17"

id_SubjectDirectoryAttributes​

• Const id_SubjectDirectoryAttributes: "2.5.29.9"

id_SubjectInfoAccess​

• Const id_SubjectInfoAccess: "1.3.6.1.5.5.7.1.11"

id_SubjectKeyIdentifier​

• Const id_SubjectKeyIdentifier: "2.5.29.14"

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_eContentType_TSTInfo​

• Const id_eContentType_TSTInfo: "1.2.840.113549.1.9.16.1.4"

id_pkix​

• Const id_pkix: "1.3.6.1.5.5.7"

id_sha1​

• Const id_sha1: "1.3.14.3.2.26"

id_sha256​

• Const id_sha256: "2.16.840.1.101.3.4.2.1"

id_sha384​

• Const id_sha384: "2.16.840.1.101.3.4.2.2"

id_sha512​

• Const id_sha512: "2.16.840.1.101.3.4.2.3"

Functions​

checkCA​

▸ checkCA(cert, signerCert?): Certificate | null

Check CA flag for the certificate

Parameters​

NameTypeDefault valueDescription
certCertificateundefinedCertificate to find CA flag for
signerCertnull | Certificatenull-

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​

NameTypeDescription
signatureBufferArrayBufferWebCrypto result of "sign" function

Returns​

ArrayBuffer

createECDSASignatureFromCMS​

▸ createECDSASignatureFromCMS(cmsSignature, pointSize): ArrayBuffer

Create a single ArrayBuffer from CMS ECDSA signature

Parameters​

NameTypeDescription
cmsSignatureAsnTypeASN.1 SEQUENCE contains CMS ECDSA signature
pointSizenumberSize of EC point. Use ECNamedCurves.find to get correct point size

Returns​

ArrayBuffer

WebCrypto signature

getAlgorithmByOID​

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

Gets WebCrypto algorithm by well-known OID

Type parameters​

NameType
Textends Algorithm = Algorithm

Parameters​

NameTypeDescription
oidstringalgorithm identifier
safety?booleanif true throws exception on unknown algorithm identifier
target?stringname of the target

Returns​

T | object

WebCrypto algorithm or an empty object

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

Type parameters​

NameType
Textends Algorithm = Algorithm

Parameters​

NameType
oidstring
safetytrue
target?string

Returns​

T

getAlgorithmParameters​

▸ getAlgorithmParameters(algorithmName, operation): CryptoEngineAlgorithmParams

Get default algorithm parameters for each kind of operation

Parameters​

NameTypeDescription
algorithmNamestringAlgorithm name to get common parameters for
operationCryptoEngineAlgorithmOperationKind of operation: "sign", "encrypt", "generateKey", "importKey", "exportKey", "verify"

Returns​

CryptoEngineAlgorithmParams

getCrypto​

▸ getCrypto(safety?): ICryptoEngine | null

Gets crypto subtle from the current "crypto engine"

Parameters​

NameType
safety?boolean

Returns​

ICryptoEngine | null

Reruns ICryptoEngine or null

▸ getCrypto(safety): ICryptoEngine

Gets crypto subtle from the current "crypto engine"

Parameters​

NameType
safetytrue

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​

NameTypeDescription
signatureAlgorithmAlgorithmIdentifierSignature algorithm

Returns​

string

getOIDByAlgorithm​

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

Get OID for each specific algorithm

Parameters​

NameTypeDescription
algorithmAlgorithmWebCrypto Algorithm
safety?booleanif true throws exception on unknown algorithm
target?stringname 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​

NameType
viewUint8Array

Returns​

Uint8Array

kdf​

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

ANS X9.63 Key Derivation Function

Parameters​

NameTypeDescription
hashFunctionstringUsed hash function
ZbufferArrayBufferArrayBuffer containing ECDH shared secret to derive from
keydatalennumberLength (!!! in BITS !!!) of used kew derivation function
SharedInfoArrayBufferUsually DER encoded "ECC_CMS_SharedInfo" structure
cryptoICryptoEngineCrypto engine

Returns​

Promise<ArrayBuffer>

setEngine​

▸ setEngine(name, crypto, subtle): void

Sets global crypto engine

Parameters​

NameTypeDescription
namestringName of the crypto engine
cryptoCrypto | ICryptoEngine
subtleSubtleCrypto | ICryptoEngine

Returns​

void

Deprecated

Since version 3.0.0

▸ setEngine(name, crypto?): void

Sets global crypto engine

Parameters​

NameTypeDescription
namestringName of the crypto engine
crypto?ICryptoEngineCrypto 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​

NameTypeDescription
inputStringstringJavaScript 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​

NameTypeDescription
certificateCertificateCertificate for which verification would be performed
issuerCertificateCertificateCertificate of the issuer of target certificate
logsLog[]Array of objects with information about each CT Log (like here: https://ct.grahamedgecombe.com/logs.json)
indexnumberIndex of SignedCertificateTimestamp inside SignedCertificateTimestampList (for -1 would verify all)
cryptoICryptoEngineCrypto engine

Returns​

Promise<boolean[]>

Array of verification results