@codebolt/codeboltjs 1.1.68 → 1.1.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.codeboltconfig.yaml +0 -0
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/_internal_.Agent.html +43 -39
- package/docs/classes/_internal_.ClientRequest.html +57 -57
- package/docs/classes/_internal_.Codebolt.html +151 -117
- package/docs/classes/_internal_.CustomEventEmitter-1.html +30 -30
- package/docs/classes/_internal_.CustomEventEmitter.html +30 -30
- package/docs/classes/_internal_.Duplex.html +30 -30
- package/docs/classes/_internal_.EventEmitter-1.html +30 -30
- package/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html +34 -34
- package/docs/classes/_internal_.IncomingMessage.html +57 -55
- package/docs/classes/_internal_.KeyObject.html +10 -10
- package/docs/classes/_internal_.OutgoingMessage.html +41 -41
- package/docs/classes/_internal_.Readable.html +28 -28
- package/docs/classes/_internal_.ReadableBase.html +27 -27
- package/docs/classes/_internal_.Server-1.html +32 -32
- package/docs/classes/_internal_.Server-2.html +24 -24
- package/docs/classes/_internal_.Server-3.html +24 -24
- package/docs/classes/_internal_.Server.html +42 -42
- package/docs/classes/_internal_.ServerResponse.html +50 -50
- package/docs/classes/_internal_.Socket.html +28 -28
- package/docs/classes/_internal_.Stream.html +28 -28
- package/docs/classes/_internal_.TLSSocket.html +29 -29
- package/docs/classes/_internal_.URL.html +19 -19
- package/docs/classes/_internal_.URLSearchParams.html +15 -15
- package/docs/classes/_internal_.WebSocket-1.html +23 -23
- package/docs/classes/_internal_.WebSocket.Server.html +23 -23
- package/docs/classes/_internal_.Writable.html +24 -24
- package/docs/classes/_internal_.WritableBase.html +23 -23
- package/docs/classes/_internal_.X509Certificate.html +26 -26
- package/docs/classes/_internal_.internal-1.html +29 -29
- package/docs/classes/_internal_.internal.PassThrough.html +30 -30
- package/docs/classes/_internal_.internal.Transform.html +30 -30
- package/docs/enums/_internal_.logType.html +2 -2
- package/docs/functions/_internal_.internal.addAbortSignal.html +2 -2
- package/docs/functions/_internal_.internal.finished-1.html +1 -1
- package/docs/functions/_internal_.internal.pipeline-1.html +1 -1
- package/docs/interfaces/_internal_.AgentOptions.html +8 -8
- package/docs/interfaces/_internal_.AsymmetricKeyDetails.html +8 -8
- package/docs/interfaces/_internal_.Buffer.html +19 -19
- package/docs/interfaces/_internal_.CryptoKey.html +5 -5
- package/docs/interfaces/_internal_.DuplexOptions.html +1 -1
- package/docs/interfaces/_internal_.EventEmitter-2.html +17 -17
- package/docs/interfaces/_internal_.EventEmitter.Abortable.html +2 -2
- package/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +2 -2
- package/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +2 -2
- package/docs/interfaces/_internal_.ExtractTextResponse.html +3 -0
- package/docs/interfaces/_internal_.GetContentResponse.html +3 -0
- package/docs/interfaces/_internal_.InformationEvent.html +2 -2
- package/docs/interfaces/_internal_.JsonWebKey.html +2 -2
- package/docs/interfaces/_internal_.JwkKeyExportOptions.html +2 -2
- package/docs/interfaces/_internal_.KeyAlgorithm.html +2 -2
- package/docs/interfaces/_internal_.KeyExportOptions.html +2 -2
- package/docs/interfaces/_internal_.ListenOptions.html +1 -1
- package/docs/interfaces/_internal_.LookupAddress.html +3 -3
- package/docs/interfaces/_internal_.LookupOptions.html +12 -5
- package/docs/interfaces/_internal_.ReadWriteStream.html +16 -16
- package/docs/interfaces/_internal_.ReadableOptions.html +1 -1
- package/docs/interfaces/_internal_.ReadableStream-1.html +16 -16
- package/docs/interfaces/_internal_.Selection.html +6 -0
- package/docs/interfaces/_internal_.ServerOptions.html +7 -8
- package/docs/interfaces/_internal_.StaticEventEmitterOptions.html +15 -2
- package/docs/interfaces/_internal_.StreamOptions.html +1 -1
- package/docs/interfaces/_internal_.UserMessage.html +3 -0
- package/docs/interfaces/_internal_.UserRequest.html +7 -0
- package/docs/interfaces/_internal_.WebSocket.WebSocket.html +11 -11
- package/docs/interfaces/_internal_.WebSocket.WebSocketServer.html +11 -11
- package/docs/interfaces/_internal_.WebSocketAlias.html +11 -11
- package/docs/interfaces/_internal_.WritableOptions.html +1 -1
- package/docs/interfaces/_internal_.WritableStream.html +16 -16
- package/docs/interfaces/_internal_.X509CheckOptions.html +6 -6
- package/docs/interfaces/_internal_.internal.FinishedOptions.html +1 -1
- package/docs/interfaces/_internal_.internal.TransformOptions.html +1 -1
- package/docs/modules/_internal_.EventEmitter.html +1 -1
- package/docs/modules/_internal_.html +5 -2
- package/docs/types/_internal_.AnyRest.html +1 -1
- package/docs/types/_internal_.Args.html +1 -1
- package/docs/types/_internal_.BinaryLike.html +1 -1
- package/docs/types/_internal_.DefaultEventMap.html +1 -1
- package/docs/types/_internal_.EventMap.html +1 -1
- package/docs/types/_internal_.Key.html +1 -1
- package/docs/types/_internal_.Key2.html +1 -1
- package/docs/types/_internal_.KeyFormat.html +1 -1
- package/docs/types/_internal_.KeyObjectType.html +1 -1
- package/docs/types/_internal_.KeyType-1.html +1 -1
- package/docs/types/_internal_.KeyType.html +1 -1
- package/docs/types/_internal_.KeyUsage.html +1 -1
- package/docs/types/_internal_.Listener.html +1 -1
- package/docs/types/_internal_.RequestListener.html +1 -1
- package/docs/variables/default.html +1 -1
- package/index.d.ts +1 -1
- package/modules/codeutils.d.ts +1 -1
- package/modules/codeutils.js +64 -94
- package/package.json +1 -3
- package/src/modules/codeutils.ts +67 -67
- package/docs/interfaces/_internal_.CommandOutput.html +0 -3
- package/docs/interfaces/_internal_.GetJsTreeResponse.html +0 -3
|
@@ -3,7 +3,7 @@ its information.</p>
|
|
|
3
3
|
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">X509Certificate</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">import</span><span class="hl-1">(</span><span class="hl-2">'node:crypto'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">x509</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">X509Certificate</span><span class="hl-1">(</span><span class="hl-2">'{... pem encoded cert ...}'</span><span class="hl-1">);</span><br/><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-7">x509</span><span class="hl-1">.</span><span class="hl-7">subject</span><span class="hl-1">);</span>
|
|
4
4
|
</code><button>Copy</button></pre>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
6
|
-
</div></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
6
|
+
</div></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3611</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_internal_.X509Certificate.html#constructor" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
7
7
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_internal_.X509Certificate.html#ca" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ca</span></a>
|
|
8
8
|
<a href="_internal_.X509Certificate.html#fingerprint" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fingerprint</span></a>
|
|
9
9
|
<a href="_internal_.X509Certificate.html#fingerprint256" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fingerprint256</span></a>
|
|
@@ -28,23 +28,23 @@ its information.</p>
|
|
|
28
28
|
<a href="_internal_.X509Certificate.html#toLegacyObject" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Legacy<wbr/>Object</span></a>
|
|
29
29
|
<a href="_internal_.X509Certificate.html#toString" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a>
|
|
30
30
|
<a href="_internal_.X509Certificate.html#verify" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>verify</span></a>
|
|
31
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_X509Certificate" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>X509<wbr/>Certificate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.X509Certificate.html" class="tsd-signature-type tsd-kind-class">X509Certificate</a><a href="#constructor.new_X509Certificate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buffer</span>: <a href="../types/_internal_.BinaryLike.html" class="tsd-signature-type tsd-kind-type-alias">BinaryLike</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_internal_.X509Certificate.html" class="tsd-signature-type tsd-kind-class">X509Certificate</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
31
|
+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_X509Certificate" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>X509<wbr/>Certificate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.X509Certificate.html" class="tsd-signature-type tsd-kind-class">X509Certificate</a><a href="#constructor.new_X509Certificate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buffer</span>: <a href="../types/_internal_.BinaryLike.html" class="tsd-signature-type tsd-kind-type-alias">BinaryLike</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_internal_.X509Certificate.html" class="tsd-signature-type tsd-kind-class">X509Certificate</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3728</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="ca" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ca</span><a href="#ca" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ca</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Will be <code>true</code> if this is a Certificate Authority (CA) certificate.</p>
|
|
32
32
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
33
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
33
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3616</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="fingerprint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>fingerprint</span><a href="#fingerprint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fingerprint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The SHA-1 fingerprint of this certificate.</p>
|
|
34
34
|
<p>Because SHA-1 is cryptographically broken and because the security of SHA-1 is
|
|
35
35
|
significantly worse than that of algorithms that are commonly used to sign
|
|
36
36
|
certificates, consider using <code>x509.fingerprint256</code> instead.</p>
|
|
37
37
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
38
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
38
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3625</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="fingerprint256" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>fingerprint256</span><a href="#fingerprint256" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fingerprint256</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The SHA-256 fingerprint of this certificate.</p>
|
|
39
39
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
40
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
40
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3630</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="fingerprint512" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>fingerprint512</span><a href="#fingerprint512" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fingerprint512</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The SHA-512 fingerprint of this certificate.</p>
|
|
41
41
|
<p>Because computing the SHA-256 fingerprint is usually faster and because it is
|
|
42
42
|
only half the size of the SHA-512 fingerprint, <code>x509.fingerprint256</code> may be
|
|
43
43
|
a better choice. While SHA-512 presumably provides a higher level of security in
|
|
44
44
|
general, the security of SHA-256 matches that of most algorithms that are
|
|
45
45
|
commonly used to sign certificates.</p>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v17.2.0, v16.14.0</p>
|
|
47
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
47
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3641</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="infoAccess" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>info<wbr/>Access</span><a href="#infoAccess" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">info<wbr/>Access</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A textual representation of the certificate's authority information access
|
|
48
48
|
extension.</p>
|
|
49
49
|
<p>This is a line feed separated list of access descriptions. Each line begins with
|
|
50
50
|
the access method and the kind of the access location, followed by a colon and
|
|
@@ -55,25 +55,25 @@ value is a JSON string literal. For backward compatibility, Node.js only uses
|
|
|
55
55
|
JSON string literals within this property when necessary to avoid ambiguity.
|
|
56
56
|
Third-party code should be prepared to handle both possible entry formats.</p>
|
|
57
57
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
58
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
58
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3682</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="issuer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>issuer</span><a href="#issuer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">issuer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The issuer identification included in this certificate.</p>
|
|
59
59
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
60
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
60
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3692</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="issuerCertificate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>issuer<wbr/>Certificate</span><a href="#issuerCertificate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">issuer<wbr/>Certificate</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.X509Certificate.html" class="tsd-signature-type tsd-kind-class">X509Certificate</a></div><div class="tsd-comment tsd-typography"><p>The issuer certificate or <code>undefined</code> if the issuer certificate is not
|
|
61
61
|
available.</p>
|
|
62
62
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.9.0</p>
|
|
63
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
63
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3698</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="keyUsage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>key<wbr/>Usage</span><a href="#keyUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">key<wbr/>Usage</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array detailing the key usages for this certificate.</p>
|
|
64
64
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
65
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
65
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3687</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="publicKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>public<wbr/>Key</span><a href="#publicKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">public<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a></div><div class="tsd-comment tsd-typography"><p>The public key <code>KeyObject</code> for this certificate.</p>
|
|
66
66
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
67
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
67
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3703</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="raw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>raw</span><a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">raw</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a></div><div class="tsd-comment tsd-typography"><p>A <code>Buffer</code> containing the DER encoding of this certificate.</p>
|
|
68
68
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
69
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
69
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3708</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="serialNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>serial<wbr/>Number</span><a href="#serialNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">serial<wbr/>Number</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The serial number of this certificate.</p>
|
|
70
70
|
<p>Serial numbers are assigned by certificate authorities and do not uniquely
|
|
71
71
|
identify certificates. Consider using <code>x509.fingerprint256</code> as a unique
|
|
72
72
|
identifier instead.</p>
|
|
73
73
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
74
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
74
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3717</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="subject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>subject</span><a href="#subject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">subject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The complete subject of this certificate.</p>
|
|
75
75
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
76
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
76
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3646</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="subjectAltName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>subject<wbr/>Alt<wbr/>Name</span><a href="#subjectAltName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">subject<wbr/>Alt<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The subject alternative name specified for this certificate.</p>
|
|
77
77
|
<p>This is a comma-separated list of subject alternative names. Each entry begins
|
|
78
78
|
with a string identifying the kind of the subject alternative name followed by
|
|
79
79
|
a colon and the value associated with the entry.</p>
|
|
@@ -87,11 +87,11 @@ For backward compatibility, Node.js only uses JSON string literals within this
|
|
|
87
87
|
property when necessary to avoid ambiguity. Third-party code should be prepared
|
|
88
88
|
to handle both possible entry formats.</p>
|
|
89
89
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
90
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
90
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3666</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="validFrom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>valid<wbr/>From</span><a href="#validFrom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">valid<wbr/>From</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The date/time from which this certificate is considered valid.</p>
|
|
91
91
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
92
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
92
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3722</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="validTo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>valid<wbr/>To</span><a href="#validTo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">valid<wbr/>To</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The date/time until which this certificate is considered valid.</p>
|
|
93
93
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
94
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
94
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3727</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="checkEmail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>check<wbr/>Email</span><a href="#checkEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="checkEmail.checkEmail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">check<wbr/>Email</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">email</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#checkEmail.checkEmail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks whether the certificate matches the given email address.</p>
|
|
95
95
|
<p>If the <code>'subject'</code> option is undefined or set to <code>'default'</code>, the certificate
|
|
96
96
|
subject is only considered if the subject alternative name extension either does
|
|
97
97
|
not exist or does not contain any email addresses.</p>
|
|
@@ -102,7 +102,7 @@ address, the certificate subject is considered.</p>
|
|
|
102
102
|
considered, even if the certificate contains no subject alternative names.</p>
|
|
103
103
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">email</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../types/_internal_.Pick.html" class="tsd-signature-type tsd-kind-type-alias">Pick</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_internal_.X509CheckOptions.html" class="tsd-signature-type tsd-kind-interface">X509CheckOptions</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"subject"</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>Returns <code>email</code> if the certificate matches, <code>undefined</code> if it does not.</p>
|
|
104
104
|
<div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
105
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
105
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3745</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="checkHost" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>check<wbr/>Host</span><a href="#checkHost" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="checkHost.checkHost-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">check<wbr/>Host</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#checkHost.checkHost-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks whether the certificate matches the given host name.</p>
|
|
106
106
|
<p>If the certificate matches the given host name, the matching subject name is
|
|
107
107
|
returned. The returned name might be an exact match (e.g., <code>foo.example.com</code>)
|
|
108
108
|
or it might contain wildcards (e.g., <code>*.example.com</code>). Because host name
|
|
@@ -118,27 +118,27 @@ the certificate subject is considered.</p>
|
|
|
118
118
|
considered, even if the certificate contains no subject alternative names.</p>
|
|
119
119
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/_internal_.X509CheckOptions.html" class="tsd-signature-type tsd-kind-interface">X509CheckOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>Returns a subject name that matches <code>name</code>, or <code>undefined</code> if no subject name matches <code>name</code>.</p>
|
|
120
120
|
<div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
121
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
121
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3768</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="checkIP" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>checkIP</span><a href="#checkIP" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="checkIP.checkIP-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">checkIP</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ip</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><a href="#checkIP.checkIP-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks whether the certificate matches the given IP address (IPv4 or IPv6).</p>
|
|
122
122
|
<p>Only <a href="https://www.rfc-editor.org/rfc/rfc5280.txt">RFC 5280</a> <code>iPAddress</code> subject alternative names are considered, and they
|
|
123
123
|
must match the given <code>ip</code> address exactly. Other subject alternative names as
|
|
124
124
|
well as the subject field of the certificate are ignored.</p>
|
|
125
125
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">ip</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>Returns <code>ip</code> if the certificate matches, <code>undefined</code> if it does not.</p>
|
|
126
126
|
<div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
127
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
127
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3778</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="checkIssued" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>check<wbr/>Issued</span><a href="#checkIssued" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="checkIssued.checkIssued-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">check<wbr/>Issued</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">otherCert</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#checkIssued.checkIssued-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks whether this certificate was issued by the given <code>otherCert</code>.</p>
|
|
128
128
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">otherCert</span>: <a href="_internal_.X509Certificate.html" class="tsd-signature-type tsd-kind-class">X509Certificate</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
129
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
129
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3783</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="checkPrivateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>check<wbr/>Private<wbr/>Key</span><a href="#checkPrivateKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="checkPrivateKey.checkPrivateKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">check<wbr/>Private<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">privateKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#checkPrivateKey.checkPrivateKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks whether the public key for this certificate is consistent with
|
|
130
130
|
the given private key.</p>
|
|
131
131
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">privateKey</span>: <a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a></span><div class="tsd-comment tsd-typography"><p>A private key.</p>
|
|
132
132
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
133
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
133
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3790</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toJSON.toJSON-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>There is no standard JSON encoding for X509 certificates. The<code>toJSON()</code> method returns a string containing the PEM encoded
|
|
134
134
|
certificate.</p>
|
|
135
135
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
136
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
136
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3796</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="toLegacyObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Legacy<wbr/>Object</span><a href="#toLegacyObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toLegacyObject.toLegacyObject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Legacy<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.PeerCertificate.html" class="tsd-signature-type tsd-kind-interface">PeerCertificate</a><a href="#toLegacyObject.toLegacyObject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns information about this certificate using the legacy <code>certificate object</code> encoding.</p>
|
|
137
137
|
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.PeerCertificate.html" class="tsd-signature-type tsd-kind-interface">PeerCertificate</a></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
138
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
138
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3801</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the PEM-encoded certificate.</p>
|
|
139
139
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
140
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
140
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3806</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="verify" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>verify</span><a href="#verify" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="verify.verify-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">verify</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">publicKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#verify.verify-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Verifies that this certificate was signed by the given public key.
|
|
141
141
|
Does not perform any other validation checks on the certificate.</p>
|
|
142
142
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">publicKey</span>: <a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a></span><div class="tsd-comment tsd-typography"><p>A public key.</p>
|
|
143
143
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.6.0</p>
|
|
144
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
144
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:3813</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#ca" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ca</span></a><a href="#fingerprint" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fingerprint</span></a><a href="#fingerprint256" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fingerprint256</span></a><a href="#fingerprint512" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fingerprint512</span></a><a href="#infoAccess" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>info<wbr/>Access</span></a><a href="#issuer" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>issuer</span></a><a href="#issuerCertificate" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>issuer<wbr/>Certificate</span></a><a href="#keyUsage" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key<wbr/>Usage</span></a><a href="#publicKey" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>public<wbr/>Key</span></a><a href="#raw" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>raw</span></a><a href="#serialNumber" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>serial<wbr/>Number</span></a><a href="#subject" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subject</span></a><a href="#subjectAltName" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subject<wbr/>Alt<wbr/>Name</span></a><a href="#validFrom" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>valid<wbr/>From</span></a><a href="#validTo" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>valid<wbr/>To</span></a><a href="#checkEmail" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>Email</span></a><a href="#checkHost" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>Host</span></a><a href="#checkIP" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>checkIP</span></a><a href="#checkIssued" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>Issued</span></a><a href="#checkPrivateKey" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>Private<wbr/>Key</span></a><a href="#toJSON" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a><a href="#toLegacyObject" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Legacy<wbr/>Object</span></a><a href="#toString" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#verify" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>verify</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@codebolt/codeboltjs</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|