diff --git a/API.md b/API.md index f767f9c..5498661 100644 --- a/API.md +++ b/API.md @@ -18,7 +18,7 @@ AES_256 | 3 | 256bit AES Encryption Name | Type | Attributes | Description --- | --- | --- | --- -certs | Array\ | optional | An array of necessary certificates. +certs | Array\ | optional | An array of necessary certificates. ocsps | Array\ | optional | An array of [OCSP](#note)s' response. crls | Array\ | optional | The array of [CRL](#note)s. @@ -50,7 +50,7 @@ pubkeys | Array\<[PubKeyInfo](#PubKeyInfo)\> | optional | An array of recipients Name | Type | Attributes | Description --- | --- | --- | --- -c | Array\
:fork_and_knife:Uint8Array
:fork_and_knife:ArrayBuffer
:fork_and_knife:string
:fork_and_knife:forge_cert | optional | A certificate. +c | Array\
:fork_and_knife:Uint8Array
:fork_and_knife:ArrayBuffer
:fork_and_knife:string
:fork_and_knife:forge.pki.Certificate | optional | A certificate. p | Array\ | optional | An array of permissions you want to block. Valid values see [EncryptOption](#encryptoption) ## SignAreaInfo @@ -189,7 +189,7 @@ raw | string | required | The target string new CertsChain(certs*opt*) Name | Type | Attributes | Description --- | --- | --- | --- -certs | Array\
:fork_and_knife:Array\
:fork_and_knife:Array\ | optional | An array of certificates. +certs | Array\
:fork_and_knife:Array\
:fork_and_knife:Array\ | optional | An array of certificates. ### Methods #### buildChain @@ -197,14 +197,14 @@ buildChain(cert) :arrow_right: Promise\ Build the certificates chain from the specified certificate, and returns true if this operation is successful. Name | Type | Attributes | Description --- | --- | --- | --- -cert | forge_cert | required | A certificate to start build by looking for it's issuer. +cert | forge.pki.Certificate | required | A certificate to start build by looking for it's issuer. #### getAllCerts -getAllCerts() :arrow_right: Array\ +getAllCerts() :arrow_right: Array\ Returns an array of all certificates. #### getSignCert -getSignCert() :arrow_right: forge_cert +getSignCert() :arrow_right: forge.pki.Certificate Returns the certificate for signing. #### isSelfSignedCert