diff options
Diffstat (limited to 'doc/classes/CryptoKey.xml')
| -rw-r--r-- | doc/classes/CryptoKey.xml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index d3cd485a5f..6db6fea779 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -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> |