noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Add documentation for crypto-related classes.

Browse Source 
Add documentation for Crypto, CryptoKey, HashingContext, and
X509Certificate.
Add documentation for `StreamPeerSSL.accept_peer`.

Ref #29871.
This commit is contained in:
Fabio Alessandrelli
2019-09-23 18:16:41 +02:00
parent 46f909f8af
commit a20cbf2cca
5 changed files with 72 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/CryptoKey.xml
View File

@@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CryptoKey" inherits="Resource" category="Core" version="3.2">
<brief_description>
A cryptographic key (RSA).
</brief_description>
<description>
The CryptoKey class represents a cryptographic key. Keys can be loaded and saved like any other [Resource].
They can be used to generate a self-signed [X509Certificate] via [method Crypto.generate_self_signed] and as private key in [method StreamPeerSSL.accept_stream] along with the appropriate certificate.
</description>
<tutorials>
</tutorials>
@@ -13,6 +16,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
Loads a key from [code]path[/code] ("*.key" file).
</description>
</method>
<method name="save">
@@ -21,6 +25,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
Saves a key to the given [code]path[/code] (should be a "*.key" file).
</description>
</method>
</methods>