81064cc239
We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
53 lines
2.5 KiB
XML
53 lines
2.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CryptoKey" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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_certificate] and as private key in [method StreamPeerTLS.accept_stream] along with the appropriate certificate.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="is_public_only" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if this CryptoKey only has the public part, and not the private one.
|
|
</description>
|
|
</method>
|
|
<method name="load">
|
|
<return type="int" enum="Error" />
|
|
<param index="0" name="path" type="String" />
|
|
<param index="1" name="public_only" type="bool" default="false" />
|
|
<description>
|
|
Loads a key from [param path]. If [param public_only] is [code]true[/code], only the public key will be loaded.
|
|
[b]Note:[/b] [param path] should be a "*.pub" file if [param public_only] is [code]true[/code], a "*.key" file otherwise.
|
|
</description>
|
|
</method>
|
|
<method name="load_from_string">
|
|
<return type="int" enum="Error" />
|
|
<param index="0" name="string_key" type="String" />
|
|
<param index="1" name="public_only" type="bool" default="false" />
|
|
<description>
|
|
Loads a key from the given [param string_key]. If [param public_only] is [code]true[/code], only the public key will be loaded.
|
|
</description>
|
|
</method>
|
|
<method name="save">
|
|
<return type="int" enum="Error" />
|
|
<param index="0" name="path" type="String" />
|
|
<param index="1" name="public_only" type="bool" default="false" />
|
|
<description>
|
|
Saves a key to the given [param path]. If [param public_only] is [code]true[/code], only the public key will be saved.
|
|
[b]Note:[/b] [param path] should be a "*.pub" file if [param public_only] is [code]true[/code], a "*.key" file otherwise.
|
|
</description>
|
|
</method>
|
|
<method name="save_to_string">
|
|
<return type="String" />
|
|
<param index="0" name="public_only" type="bool" default="false" />
|
|
<description>
|
|
Returns a string containing the key in PEM format. If [param public_only] is [code]true[/code], only the public key will be included.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|