Skip to content

Commit

Permalink
updated generated documentation on webpage by github-action [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Jun 25, 2024
1 parent 7611818 commit 20dbc1d
Show file tree
Hide file tree
Showing 11 changed files with 140 additions and 61 deletions.
60 changes: 30 additions & 30 deletions static/doc/master/CMakeFiles/doc.dir/build.make
View file

Large diffs are not rendered by default.

60 changes: 30 additions & 30 deletions static/doc/master/CMakeFiles/doc_latex.dir/build.make
View file

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions static/doc/master/_sources/plugin_securitypolicy.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,9 @@ SecurityPolicy
* depends on the used key length. */
UA_ByteString localCertificate;
UA_NodeId certificateGroupId;
UA_NodeId certificateTypeId;
/* Function pointers grouped into modules */
UA_SecurityPolicyAsymmetricModule asymmetricModule;
UA_SecurityPolicySymmetricModule symmetricModule;
Expand All @@ -298,6 +301,15 @@ SecurityPolicy
const UA_ByteString newCertificate,
const UA_ByteString newPrivateKey);
/* Creates a PKCS #10 DER encoded certificate request signed with the server's
* private key. */
UA_StatusCode (*createSigningRequest)(UA_SecurityPolicy *securityPolicy,
const UA_String *subjectName,
const UA_ByteString *nonce,
const UA_KeyValueMap *params,
UA_ByteString *csr,
UA_ByteString *newPrivateKey);
/* Deletes the dynamic content of the policy */
void (*clear)(UA_SecurityPolicy *policy);
};
Expand Down
14 changes: 14 additions & 0 deletions static/doc/master/_sources/server.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1938,6 +1938,20 @@ Update the Server Certificate at Runtime
UA_Boolean closeSessions,
UA_Boolean closeSecureChannels);
Creates a PKCS #10 DER encoded certificate request signed with the server's private key
----------------------------------------------------------------------------------------

.. code-block:: c
UA_StatusCode
UA_Server_createSigningRequest(UA_Server *server,
const UA_NodeId certificateGroupId,
const UA_NodeId certificateTypeId,
const UA_String *subjectName,
const UA_Boolean *regenerateKey,
const UA_ByteString *nonce,
UA_ByteString *csr);
Utility Functions
-----------------

Expand Down
12 changes: 12 additions & 0 deletions static/doc/master/_static/plugin_securitypolicy.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,9 @@ SecurityPolicy
* depends on the used key length. */
UA_ByteString localCertificate;
UA_NodeId certificateGroupId;
UA_NodeId certificateTypeId;
/* Function pointers grouped into modules */
UA_SecurityPolicyAsymmetricModule asymmetricModule;
UA_SecurityPolicySymmetricModule symmetricModule;
Expand All @@ -298,6 +301,15 @@ SecurityPolicy
const UA_ByteString newCertificate,
const UA_ByteString newPrivateKey);
/* Creates a PKCS #10 DER encoded certificate request signed with the server's
* private key. */
UA_StatusCode (*createSigningRequest)(UA_SecurityPolicy *securityPolicy,
const UA_String *subjectName,
const UA_ByteString *nonce,
const UA_KeyValueMap *params,
UA_ByteString *csr,
UA_ByteString *newPrivateKey);
/* Deletes the dynamic content of the policy */
void (*clear)(UA_SecurityPolicy *policy);
};
Expand Down
14 changes: 14 additions & 0 deletions static/doc/master/_static/server.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1938,6 +1938,20 @@ Update the Server Certificate at Runtime
UA_Boolean closeSessions,
UA_Boolean closeSecureChannels);
Creates a PKCS #10 DER encoded certificate request signed with the server's private key
----------------------------------------------------------------------------------------

.. code-block:: c
UA_StatusCode
UA_Server_createSigningRequest(UA_Server *server,
const UA_NodeId certificateGroupId,
const UA_NodeId certificateTypeId,
const UA_String *subjectName,
const UA_Boolean *regenerateKey,
const UA_ByteString *nonce,
UA_ByteString *csr);
Utility Functions
-----------------

Expand Down
12 changes: 12 additions & 0 deletions static/doc/master/plugin_securitypolicy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,9 @@ <h1>SecurityPolicy<a class="headerlink" href="#securitypolicy" title="Link to th
<span class="cm"> * depends on the used key length. */</span>
<span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="n">localCertificate</span><span class="p">;</span>

<span class="w"> </span><span class="n">UA_NodeId</span><span class="w"> </span><span class="n">certificateGroupId</span><span class="p">;</span>
<span class="w"> </span><span class="n">UA_NodeId</span><span class="w"> </span><span class="n">certificateTypeId</span><span class="p">;</span>

<span class="w"> </span><span class="cm">/* Function pointers grouped into modules */</span>
<span class="w"> </span><span class="n">UA_SecurityPolicyAsymmetricModule</span><span class="w"> </span><span class="n">asymmetricModule</span><span class="p">;</span>
<span class="w"> </span><span class="n">UA_SecurityPolicySymmetricModule</span><span class="w"> </span><span class="n">symmetricModule</span><span class="p">;</span>
Expand All @@ -390,6 +393,15 @@ <h1>SecurityPolicy<a class="headerlink" href="#securitypolicy" title="Link to th
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="n">newCertificate</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="n">newPrivateKey</span><span class="p">);</span>

<span class="w"> </span><span class="cm">/* Creates a PKCS #10 DER encoded certificate request signed with the server&#39;s</span>
<span class="cm"> * private key. */</span>
<span class="w"> </span><span class="n">UA_StatusCode</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">createSigningRequest</span><span class="p">)(</span><span class="n">UA_SecurityPolicy</span><span class="w"> </span><span class="o">*</span><span class="n">securityPolicy</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_String</span><span class="w"> </span><span class="o">*</span><span class="n">subjectName</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="o">*</span><span class="n">nonce</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_KeyValueMap</span><span class="w"> </span><span class="o">*</span><span class="n">params</span><span class="p">,</span>
<span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="o">*</span><span class="n">csr</span><span class="p">,</span>
<span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="o">*</span><span class="n">newPrivateKey</span><span class="p">);</span>

<span class="w"> </span><span class="cm">/* Deletes the dynamic content of the policy */</span>
<span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">clear</span><span class="p">)(</span><span class="n">UA_SecurityPolicy</span><span class="w"> </span><span class="o">*</span><span class="n">policy</span><span class="p">);</span>
<span class="p">};</span>
Expand Down
2 changes: 1 addition & 1 deletion static/doc/master/searchindex.js
View file

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions static/doc/master/server.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
<li class="toctree-l2"><a class="reference internal" href="#events">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="#alarms-conditions-experimental">Alarms &amp; Conditions (Experimental)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#update-the-server-certificate-at-runtime">Update the Server Certificate at Runtime</a></li>
<li class="toctree-l2"><a class="reference internal" href="#creates-a-pkcs-10-der-encoded-certificate-request-signed-with-the-server-s-private-key">Creates a PKCS #10 DER encoded certificate request signed with the server’s private key</a></li>
<li class="toctree-l2"><a class="reference internal" href="#utility-functions">Utility Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id8">Async Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="#statistics">Statistics</a></li>
Expand Down Expand Up @@ -1971,6 +1972,19 @@ <h2>Update the Server Certificate at Runtime<a class="headerlink" href="#update-
</pre></div>
</div>
</section>
<section id="creates-a-pkcs-10-der-encoded-certificate-request-signed-with-the-server-s-private-key">
<h2>Creates a PKCS #10 DER encoded certificate request signed with the server’s private key<a class="headerlink" href="#creates-a-pkcs-10-der-encoded-certificate-request-signed-with-the-server-s-private-key" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">UA_StatusCode</span>
<span class="nf">UA_Server_createSigningRequest</span><span class="p">(</span><span class="n">UA_Server</span><span class="w"> </span><span class="o">*</span><span class="n">server</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_NodeId</span><span class="w"> </span><span class="n">certificateGroupId</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_NodeId</span><span class="w"> </span><span class="n">certificateTypeId</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_String</span><span class="w"> </span><span class="o">*</span><span class="n">subjectName</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_Boolean</span><span class="w"> </span><span class="o">*</span><span class="n">regenerateKey</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="o">*</span><span class="n">nonce</span><span class="p">,</span>
<span class="w"> </span><span class="n">UA_ByteString</span><span class="w"> </span><span class="o">*</span><span class="n">csr</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="utility-functions">
<h2>Utility Functions<a class="headerlink" href="#utility-functions" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cm">/* Lookup a datatype by its NodeId. Takes the custom types in the server</span>
Expand Down
1 change: 1 addition & 0 deletions static/doc/master/toc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,7 @@ <h1>open62541 Documentation<a class="headerlink" href="#open62541-documentation"
<li class="toctree-l2"><a class="reference internal" href="server.html#events">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="server.html#alarms-conditions-experimental">Alarms &amp; Conditions (Experimental)</a></li>
<li class="toctree-l2"><a class="reference internal" href="server.html#update-the-server-certificate-at-runtime">Update the Server Certificate at Runtime</a></li>
<li class="toctree-l2"><a class="reference internal" href="server.html#creates-a-pkcs-10-der-encoded-certificate-request-signed-with-the-server-s-private-key">Creates a PKCS #10 DER encoded certificate request signed with the server’s private key</a></li>
<li class="toctree-l2"><a class="reference internal" href="server.html#utility-functions">Utility Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="server.html#id8">Async Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="server.html#statistics">Statistics</a></li>
Expand Down
Binary file modified static/doc/open62541-master.pdf
View file
Binary file not shown.

0 comments on commit 20dbc1d

Please sign in to comment.