summaryrefslogtreecommitdiff
path: root/doc/classes/X509Certificate.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/X509Certificate.xml')
-rw-r--r--doc/classes/X509Certificate.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/X509Certificate.xml b/doc/classes/X509Certificate.xml
index 013f768843..8066f65391 100644
--- a/doc/classes/X509Certificate.xml
+++ b/doc/classes/X509Certificate.xml
@@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="X509Certificate" inherits="Resource" category="Core" version="3.2">
<brief_description>
+ An X509 certificate (e.g. for SSL).
</brief_description>
<description>
+ The X509Certificate class represents an X509 certificate. Certificates can be loaded and saved like any other [Resource].
+ They can be used as the server certificate in [StreamPeerSSL.accept_stream] (along with the proper [CryptoKey]), and to specify the only certificate that should be accepted when connecting to an SSL server via [StreamPeerSSL.connect_to_stream].
</description>
<tutorials>
</tutorials>
@@ -13,6 +16,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
+ Loads a certificate from [code]path[/code] ("*.crt" file).
</description>
</method>
<method name="save">
@@ -21,6 +25,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
+ Saves a certificate to the given [code]path[/code] (should be a "*.crt" file).
</description>
</method>
</methods>