Skip to content

Commit

Permalink
Doxygen for c671c11
Browse files Browse the repository at this point in the history
  • Loading branch information
@ActoryOu
ActoryOu committed Nov 9, 2023
1 parent 2fa362d commit 537f1f3
Show file tree
Hide file tree
Showing 25 changed files with 253 additions and 217 deletions.
4 changes: 2 additions & 2 deletions main/core__pkcs11__mbedtls_8c.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a92427274c3174ef89fbf82a0
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ( mbedtls_high_level_strerr( mbedTlsCode ) != NULL ) ? \</div>
<div class="line"> mbedtls_high_level_strerr( mbedTlsCode ) : <a class="code hl_variable" href="core__pkcs11__mbedtls_8c.html#ac80d2c725e8e5238f649a2ed75e67c30">pNoHighLevelMbedTlsCodeStr</a></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ac80d2c725e8e5238f649a2ed75e67c30"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ac80d2c725e8e5238f649a2ed75e67c30">pNoHighLevelMbedTlsCodeStr</a></div><div class="ttdeci">static const char * pNoHighLevelMbedTlsCodeStr</div><div class="ttdoc">Represents string to be logged when mbedTLS returned error does not contain a high-level code.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:76</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ac80d2c725e8e5238f649a2ed75e67c30"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ac80d2c725e8e5238f649a2ed75e67c30">pNoHighLevelMbedTlsCodeStr</a></div><div class="ttdeci">static const char * pNoHighLevelMbedTlsCodeStr</div><div class="ttdoc">Represents string to be logged when mbedTLS returned error does not contain a high-level code.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:82</div></div>
</div><!-- fragment -->
<p>Utility for converting the high-level code in an mbedTLS error to string, if the code-contains a high-level code; otherwise, using a default string. </p>

Expand All @@ -534,7 +534,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1936e3a07702240561149805
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ( mbedtls_low_level_strerr( mbedTlsCode ) != NULL ) ? \</div>
<div class="line"> mbedtls_low_level_strerr( mbedTlsCode ) : <a class="code hl_variable" href="core__pkcs11__mbedtls_8c.html#ac3215d33b1ac379cd57b6458609de535">pNoLowLevelMbedTlsCodeStr</a></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ac3215d33b1ac379cd57b6458609de535"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ac3215d33b1ac379cd57b6458609de535">pNoLowLevelMbedTlsCodeStr</a></div><div class="ttdeci">static const char * pNoLowLevelMbedTlsCodeStr</div><div class="ttdoc">Represents string to be logged when mbedTLS returned error does not contain a low-level code.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:82</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ac3215d33b1ac379cd57b6458609de535"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ac3215d33b1ac379cd57b6458609de535">pNoLowLevelMbedTlsCodeStr</a></div><div class="ttdeci">static const char * pNoLowLevelMbedTlsCodeStr</div><div class="ttdoc">Represents string to be logged when mbedTLS returned error does not contain a low-level code.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:88</div></div>
</div><!-- fragment -->
<p>Utility for converting the level-level code in an mbedTLS error to string, if the code-contains a level-level code; otherwise, using a default string. </p>

Expand Down
26 changes: 13 additions & 13 deletions main/pkcs11_mbedtls_function_c_closesession.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,19 +153,19 @@
<div class="ttc" id="acore__pkcs11_8h_html_a30315d302108bcfb354196f37b16a492"><div class="ttname"><a href="core__pkcs11_8h.html#a30315d302108bcfb354196f37b16a492">CK_DECLARE_FUNCTION</a></div><div class="ttdeci">#define CK_DECLARE_FUNCTION(returnType, name)</div><div class="ttdoc">Macro for defining a PKCS #11 functions.</div><div class="ttdef"><b>Definition:</b> core_pkcs11.h:77</div></div>
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_a00810b1cb9d2f25d25ce2d4d93815fba"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#a00810b1cb9d2f25d25ce2d4d93815fba">LogInfo</a></div><div class="ttdeci">#define LogInfo(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Info&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:357</div></div>
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_a8d9dbaaa88129137a4c68ba0456a18b1"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#a8d9dbaaa88129137a4c68ba0456a18b1">LogError</a></div><div class="ttdeci">#define LogError(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Error&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:317</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a61d2aa023bf1b179d662d7a959348c0c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a61d2aa023bf1b179d662d7a959348c0c">xP11Context</a></div><div class="ttdeci">static P11Struct_t xP11Context</div><div class="ttdoc">The global PKCS #11 module object. Entropy/randomness and object lists are shared across PKCS #11 ses...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:326</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7b281bde3593fa0973cac1a3c3745a8c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7b281bde3593fa0973cac1a3c3745a8c">prvSessionPointerFromHandle</a></div><div class="ttdeci">static P11Session_t * prvSessionPointerFromHandle(CK_SESSION_HANDLE xSession)</div><div class="ttdoc">Maps an opaque caller session handle into its internal state structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:382</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ae2ce0be368072fa83e0b1f5136b7b753"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ae2ce0be368072fa83e0b1f5136b7b753">C_CloseSession</a></div><div class="ttdeci">CK_RV C_CloseSession(CK_SESSION_HANDLE hSession)</div><div class="ttdoc">Closes a session.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:1961</div></div>
<div class="ttc" id="astruct_p11_session__t_html"><div class="ttname"><a href="struct_p11_session__t.html">P11Session_t</a></div><div class="ttdoc">Session structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:299</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a01a1d13faae5fee4e8c8b76badb7fabf"><div class="ttname"><a href="struct_p11_session__t.html#a01a1d13faae5fee4e8c8b76badb7fabf">P11Session_t::xSignKeyHandle</a></div><div class="ttdeci">CK_OBJECT_HANDLE xSignKeyHandle</div><div class="ttdoc">Object handle to the signing key.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:311</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a12aac1e5f178a7b71a88bd83a6316d5d"><div class="ttname"><a href="struct_p11_session__t.html#a12aac1e5f178a7b71a88bd83a6316d5d">P11Session_t::xVerifyMutex</a></div><div class="ttdeci">mbedtls_threading_mutex_t xVerifyMutex</div><div class="ttdoc">Protects the verification key from being modified while in use.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:306</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a335416e156facf8dc065d2b1550047da"><div class="ttname"><a href="struct_p11_session__t.html#a335416e156facf8dc065d2b1550047da">P11Session_t::xSHA256Context</a></div><div class="ttdeci">mbedtls_sha256_context xSHA256Context</div><div class="ttdoc">Context for in progress digest operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:313</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a75880c73f99a62ce084a5d2ecc05421b"><div class="ttname"><a href="struct_p11_session__t.html#a75880c73f99a62ce084a5d2ecc05421b">P11Session_t::xVerifyKey</a></div><div class="ttdeci">mbedtls_pk_context xVerifyKey</div><div class="ttdoc">Verification key. Set during C_VerifyInit.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:308</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a789e8a76ef3043347f3185678595c8e3"><div class="ttname"><a href="struct_p11_session__t.html#a789e8a76ef3043347f3185678595c8e3">P11Session_t::xOpened</a></div><div class="ttdeci">CK_BBOOL xOpened</div><div class="ttdoc">Set to CK_TRUE upon opening PKCS #11 session.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:301</div></div>
<div class="ttc" id="astruct_p11_session__t_html_ab740704e3cd0a5a4e9e5ef756f9ff384"><div class="ttname"><a href="struct_p11_session__t.html#ab740704e3cd0a5a4e9e5ef756f9ff384">P11Session_t::xVerifyKeyHandle</a></div><div class="ttdeci">CK_OBJECT_HANDLE xVerifyKeyHandle</div><div class="ttdoc">Object handle to the verification key.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:307</div></div>
<div class="ttc" id="astruct_p11_session__t_html_abc6d27471e92686faee54a9a4be9d770"><div class="ttname"><a href="struct_p11_session__t.html#abc6d27471e92686faee54a9a4be9d770">P11Session_t::xSignMutex</a></div><div class="ttdeci">mbedtls_threading_mutex_t xSignMutex</div><div class="ttdoc">Protects the signing key from being modified while in use.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:310</div></div>
<div class="ttc" id="astruct_p11_session__t_html_ae954bd4ce22253542065d19e5187dda9"><div class="ttname"><a href="struct_p11_session__t.html#ae954bd4ce22253542065d19e5187dda9">P11Session_t::xSignKey</a></div><div class="ttdeci">mbedtls_pk_context xSignKey</div><div class="ttdoc">Signing key. Set during C_SignInit.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:312</div></div>
<div class="ttc" id="astruct_p11_struct__t_html_adadf5bdd5a81f36f7ffaad5ccdaf220e"><div class="ttname"><a href="struct_p11_struct__t.html#adadf5bdd5a81f36f7ffaad5ccdaf220e">P11Struct_t::xIsInitialized</a></div><div class="ttdeci">CK_BBOOL xIsInitialized</div><div class="ttdoc">Indicates whether PKCS #11 module has been initialized with a call to C_Initialize.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:285</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a61d2aa023bf1b179d662d7a959348c0c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a61d2aa023bf1b179d662d7a959348c0c">xP11Context</a></div><div class="ttdeci">static P11Struct_t xP11Context</div><div class="ttdoc">The global PKCS #11 module object. Entropy/randomness and object lists are shared across PKCS #11 ses...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:332</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7b281bde3593fa0973cac1a3c3745a8c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7b281bde3593fa0973cac1a3c3745a8c">prvSessionPointerFromHandle</a></div><div class="ttdeci">static P11Session_t * prvSessionPointerFromHandle(CK_SESSION_HANDLE xSession)</div><div class="ttdoc">Maps an opaque caller session handle into its internal state structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:388</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ae2ce0be368072fa83e0b1f5136b7b753"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ae2ce0be368072fa83e0b1f5136b7b753">C_CloseSession</a></div><div class="ttdeci">CK_RV C_CloseSession(CK_SESSION_HANDLE hSession)</div><div class="ttdoc">Closes a session.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:1967</div></div>
<div class="ttc" id="astruct_p11_session__t_html"><div class="ttname"><a href="struct_p11_session__t.html">P11Session_t</a></div><div class="ttdoc">Session structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:305</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a01a1d13faae5fee4e8c8b76badb7fabf"><div class="ttname"><a href="struct_p11_session__t.html#a01a1d13faae5fee4e8c8b76badb7fabf">P11Session_t::xSignKeyHandle</a></div><div class="ttdeci">CK_OBJECT_HANDLE xSignKeyHandle</div><div class="ttdoc">Object handle to the signing key.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:317</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a12aac1e5f178a7b71a88bd83a6316d5d"><div class="ttname"><a href="struct_p11_session__t.html#a12aac1e5f178a7b71a88bd83a6316d5d">P11Session_t::xVerifyMutex</a></div><div class="ttdeci">mbedtls_threading_mutex_t xVerifyMutex</div><div class="ttdoc">Protects the verification key from being modified while in use.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:312</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a335416e156facf8dc065d2b1550047da"><div class="ttname"><a href="struct_p11_session__t.html#a335416e156facf8dc065d2b1550047da">P11Session_t::xSHA256Context</a></div><div class="ttdeci">mbedtls_sha256_context xSHA256Context</div><div class="ttdoc">Context for in progress digest operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:319</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a75880c73f99a62ce084a5d2ecc05421b"><div class="ttname"><a href="struct_p11_session__t.html#a75880c73f99a62ce084a5d2ecc05421b">P11Session_t::xVerifyKey</a></div><div class="ttdeci">mbedtls_pk_context xVerifyKey</div><div class="ttdoc">Verification key. Set during C_VerifyInit.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:314</div></div>
<div class="ttc" id="astruct_p11_session__t_html_a789e8a76ef3043347f3185678595c8e3"><div class="ttname"><a href="struct_p11_session__t.html#a789e8a76ef3043347f3185678595c8e3">P11Session_t::xOpened</a></div><div class="ttdeci">CK_BBOOL xOpened</div><div class="ttdoc">Set to CK_TRUE upon opening PKCS #11 session.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:307</div></div>
<div class="ttc" id="astruct_p11_session__t_html_ab740704e3cd0a5a4e9e5ef756f9ff384"><div class="ttname"><a href="struct_p11_session__t.html#ab740704e3cd0a5a4e9e5ef756f9ff384">P11Session_t::xVerifyKeyHandle</a></div><div class="ttdeci">CK_OBJECT_HANDLE xVerifyKeyHandle</div><div class="ttdoc">Object handle to the verification key.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:313</div></div>
<div class="ttc" id="astruct_p11_session__t_html_abc6d27471e92686faee54a9a4be9d770"><div class="ttname"><a href="struct_p11_session__t.html#abc6d27471e92686faee54a9a4be9d770">P11Session_t::xSignMutex</a></div><div class="ttdeci">mbedtls_threading_mutex_t xSignMutex</div><div class="ttdoc">Protects the signing key from being modified while in use.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:316</div></div>
<div class="ttc" id="astruct_p11_session__t_html_ae954bd4ce22253542065d19e5187dda9"><div class="ttname"><a href="struct_p11_session__t.html#ae954bd4ce22253542065d19e5187dda9">P11Session_t::xSignKey</a></div><div class="ttdeci">mbedtls_pk_context xSignKey</div><div class="ttdoc">Signing key. Set during C_SignInit.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:318</div></div>
<div class="ttc" id="astruct_p11_struct__t_html_adadf5bdd5a81f36f7ffaad5ccdaf220e"><div class="ttname"><a href="struct_p11_struct__t.html#adadf5bdd5a81f36f7ffaad5ccdaf220e">P11Struct_t::xIsInitialized</a></div><div class="ttdeci">CK_BBOOL xIsInitialized</div><div class="ttdoc">Indicates whether PKCS #11 module has been initialized with a call to C_Initialize.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:291</div></div>
</div><!-- fragment --><p>Closes a session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
Expand Down
Loading

0 comments on commit 537f1f3

Please sign in to comment.