Skip to content

Commit 1daaa28

Browse files
graebmgraebm
authored
udpate docs for PKCS#11 (#221)
1 parent 03db033 commit 1daaa28

24 files changed

+963
-77
lines changed

‎docs/assets/js/search.json

+1-1
Large diffs are not rendered by default.

‎docs/classes/aws_iot.awsiotmqttconnectionconfigbuilder.html

+34-1
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ <h3>Methods</h3>
105105
<li class="tsd-kind-method tsd-parent-kind-class"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#with_will" class="tsd-kind-icon">with_<wbr>will</a></li>
106106
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_builder" class="tsd-kind-icon">new_<wbr>mtls_<wbr>builder</a></li>
107107
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_builder_from_path" class="tsd-kind-icon">new_<wbr>mtls_<wbr>builder_<wbr>from_<wbr>path</a></li>
108+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_pkcs11_builder" class="tsd-kind-icon">new_<wbr>mtls_<wbr>pkcs11_<wbr>builder</a></li>
108109
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_websocket_builder" class="tsd-kind-icon">new_<wbr>websocket_<wbr>builder</a></li>
109110
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_with_websockets" class="tsd-kind-icon">new_<wbr>with_<wbr>websockets</a></li>
110111
</ul>
@@ -126,7 +127,7 @@ <h3>build</h3>
126127
</aside>
127128
<div class="tsd-comment tsd-typography">
128129
<div class="lead">
129-
<p>Returns the configured MqttConnectionConfig. On the first invocation of this function, the tls context is cached
130+
<p>Returns the configured MqttConnectionConfig. On the first invocation of this function, the TLS context is cached
130131
and re-used on all subsequent calls to build().</p>
131132
</div>
132133
</div>
@@ -624,6 +625,35 @@ <h4 class="tsd-returns-title">Returns <a href="aws_iot.awsiotmqttconnectionconfi
624625
</li>
625626
</ul>
626627
</section>
628+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
629+
<a name="new_mtls_pkcs11_builder" class="tsd-anchor"></a>
630+
<h3><span class="tsd-flag ts-flagStatic">Static</span> new_<wbr>mtls_<wbr>pkcs11_<wbr>builder</h3>
631+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
632+
<li class="tsd-signature tsd-kind-icon">new_<wbr>mtls_<wbr>pkcs11_<wbr>builder<span class="tsd-signature-symbol">(</span>pkcs11_options<span class="tsd-signature-symbol">: </span><a href="io.tlscontextoptions.html#pkcs11options" class="tsd-signature-type">Pkcs11Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="aws_iot.awsiotmqttconnectionconfigbuilder.html" class="tsd-signature-type">AwsIotMqttConnectionConfigBuilder</a></li>
633+
</ul>
634+
<ul class="tsd-descriptions">
635+
<li class="tsd-description">
636+
<aside class="tsd-sources">
637+
</aside>
638+
<div class="tsd-comment tsd-typography">
639+
<div class="lead">
640+
<p>Create a new builder with mTLS using a PKCS#11 library for private key operations.</p>
641+
</div>
642+
<p>NOTE: This configuration only works on Unix devices.</p>
643+
</div>
644+
<h4 class="tsd-parameters-title">Parameters</h4>
645+
<ul class="tsd-parameters">
646+
<li>
647+
<h5>pkcs11_options: <a href="io.tlscontextoptions.html#pkcs11options" class="tsd-signature-type">Pkcs11Options</a></h5>
648+
<div class="tsd-comment tsd-typography">
649+
<p>PKCS#11 options.</p>
650+
</div>
651+
</li>
652+
</ul>
653+
<h4 class="tsd-returns-title">Returns <a href="aws_iot.awsiotmqttconnectionconfigbuilder.html" class="tsd-signature-type">AwsIotMqttConnectionConfigBuilder</a></h4>
654+
</li>
655+
</ul>
656+
</section>
627657
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
628658
<a name="new_websocket_builder" class="tsd-anchor"></a>
629659
<h3><span class="tsd-flag ts-flagStatic">Static</span> new_<wbr>websocket_<wbr>builder</h3>
@@ -761,6 +791,9 @@ <h4 class="tsd-returns-title">Returns <a href="aws_iot.awsiotmqttconnectionconfi
761791
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
762792
<a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_builder_from_path" class="tsd-kind-icon">new_<wbr>mtls_<wbr>builder_<wbr>from_<wbr>path</a>
763793
</li>
794+
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
795+
<a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_mtls_pkcs11_builder" class="tsd-kind-icon">new_<wbr>mtls_<wbr>pkcs11_<wbr>builder</a>
796+
</li>
764797
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
765798
<a href="aws_iot.awsiotmqttconnectionconfigbuilder.html#new_websocket_builder" class="tsd-kind-icon">new_<wbr>websocket_<wbr>builder</a>
766799
</li>

‎docs/classes/aws_iot_device_sdk.discoveryclient.html

+27-3
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ <h3>Constructors</h3>
9595
<h3>Properties</h3>
9696
<ul class="tsd-index-list">
9797
<li class="tsd-kind-property tsd-parent-kind-class"><a href="aws_iot_device_sdk.discoveryclient.html#bootstrap" class="tsd-kind-icon">bootstrap</a></li>
98+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="aws_iot_device_sdk.discoveryclient.html#gg_server_name" class="tsd-kind-icon">gg_<wbr>server_<wbr>name</a></li>
9899
<li class="tsd-kind-property tsd-parent-kind-class"><a href="aws_iot_device_sdk.discoveryclient.html#region" class="tsd-kind-icon">region</a></li>
99100
</ul>
100101
</section>
@@ -113,7 +114,7 @@ <h2>Constructors</h2>
113114
<a name="constructor" class="tsd-anchor"></a>
114115
<h3>constructor</h3>
115116
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
116-
<li class="tsd-signature tsd-kind-icon">new <wbr>Discovery<wbr>Client<span class="tsd-signature-symbol">(</span>bootstrap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientBootstrap</span>, socket_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SocketOptions</span>, tls_ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientTlsContext</span>, region<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="aws_iot_device_sdk.discoveryclient.html" class="tsd-signature-type">DiscoveryClient</a></li>
117+
<li class="tsd-signature tsd-kind-icon">new <wbr>Discovery<wbr>Client<span class="tsd-signature-symbol">(</span>bootstrap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientBootstrap</span>, socket_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SocketOptions</span>, tls_ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientTlsContext</span>, region<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gg_server_name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="aws_iot_device_sdk.discoveryclient.html" class="tsd-signature-type">DiscoveryClient</a></li>
117118
</ul>
118119
<ul class="tsd-descriptions">
119120
<li class="tsd-description">
@@ -151,7 +152,15 @@ <h5>tls_ctx: <span class="tsd-signature-type">ClientTlsContext</span></h5>
151152
<h5>region: <span class="tsd-signature-type">string</span></h5>
152153
<div class="tsd-comment tsd-typography">
153154
<div class="lead">
154-
<p>Region to send Greengrass discovery requests to</p>
155+
<p>Region to send Greengrass discovery requests to (ignored if gg_server_name is set)</p>
156+
</div>
157+
</div>
158+
</li>
159+
<li>
160+
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> gg_server_name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></h5>
161+
<div class="tsd-comment tsd-typography">
162+
<div class="lead">
163+
<p>Optional name of greengrass endpoint</p>
155164
</div>
156165
</div>
157166
</li>
@@ -175,6 +184,18 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> bootstrap</h3>
175184
</div>
176185
</div>
177186
</section>
187+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
188+
<a name="gg_server_name" class="tsd-anchor"></a>
189+
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> gg_<wbr>server_<wbr>name</h3>
190+
<div class="tsd-signature tsd-kind-icon">gg_<wbr>server_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
191+
<aside class="tsd-sources">
192+
</aside>
193+
<div class="tsd-comment tsd-typography">
194+
<div class="lead">
195+
<p>Optional name of greengrass endpoint</p>
196+
</div>
197+
</div>
198+
</section>
178199
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
179200
<a name="region" class="tsd-anchor"></a>
180201
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> region</h3>
@@ -183,7 +204,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> region</h3>
183204
</aside>
184205
<div class="tsd-comment tsd-typography">
185206
<div class="lead">
186-
<p>Region to send Greengrass discovery requests to</p>
207+
<p>Region to send Greengrass discovery requests to (ignored if gg_server_name is set)</p>
187208
</div>
188209
</div>
189210
</section>
@@ -266,6 +287,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
266287
<li class=" tsd-kind-property tsd-parent-kind-class">
267288
<a href="aws_iot_device_sdk.discoveryclient.html#bootstrap" class="tsd-kind-icon">bootstrap</a>
268289
</li>
290+
<li class=" tsd-kind-property tsd-parent-kind-class">
291+
<a href="aws_iot_device_sdk.discoveryclient.html#gg_server_name" class="tsd-kind-icon">gg_<wbr>server_<wbr>name</a>
292+
</li>
269293
<li class=" tsd-kind-property tsd-parent-kind-class">
270294
<a href="aws_iot_device_sdk.discoveryclient.html#region" class="tsd-kind-icon">region</a>
271295
</li>

‎docs/classes/io.clientbootstrap.html

+3
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,9 @@ <h4 class="tsd-returns-title">Returns <a href="io.clientbootstrap.html" class="t
184184
<li class=" tsd-kind-class tsd-parent-kind-module">
185185
<a href="io.inputstream.html" class="tsd-kind-icon">Input<wbr>Stream</a>
186186
</li>
187+
<li class=" tsd-kind-class tsd-parent-kind-module">
188+
<a href="io.pkcs11lib.html" class="tsd-kind-icon">Pkcs11<wbr>Lib</a>
189+
</li>
187190
<li class=" tsd-kind-class tsd-parent-kind-module">
188191
<a href="io.servertlscontext.html" class="tsd-kind-icon">Server<wbr>Tls<wbr>Context</a>
189192
</li>

‎docs/classes/io.clienttlscontext.html

+3
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,9 @@ <h4 class="tsd-returns-title">Returns <a href="io.clienttlscontext.html" class="
190190
<li class=" tsd-kind-class tsd-parent-kind-module">
191191
<a href="io.inputstream.html" class="tsd-kind-icon">Input<wbr>Stream</a>
192192
</li>
193+
<li class=" tsd-kind-class tsd-parent-kind-module">
194+
<a href="io.pkcs11lib.html" class="tsd-kind-icon">Pkcs11<wbr>Lib</a>
195+
</li>
193196
<li class=" tsd-kind-class tsd-parent-kind-module">
194197
<a href="io.servertlscontext.html" class="tsd-kind-icon">Server<wbr>Tls<wbr>Context</a>
195198
</li>

‎docs/classes/io.inputstream.html

+3
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,9 @@ <h4 class="tsd-returns-title">Returns <a href="io.inputstream.html" class="tsd-s
189189
</li>
190190
</ul>
191191
<ul class="after-current">
192+
<li class=" tsd-kind-class tsd-parent-kind-module">
193+
<a href="io.pkcs11lib.html" class="tsd-kind-icon">Pkcs11<wbr>Lib</a>
194+
</li>
192195
<li class=" tsd-kind-class tsd-parent-kind-module">
193196
<a href="io.servertlscontext.html" class="tsd-kind-icon">Server<wbr>Tls<wbr>Context</a>
194197
</li>

0 commit comments

Comments
 (0)