summaryrefslogtreecommitdiff
path: root/doc/classes/X509Certificate.xml
blob: e5d8b45db69447d48fe9cb54bf67672bb72c5c0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?xml version="1.0" encoding="UTF-8" ?>
<class name="X509Certificate" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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 [method 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 [method StreamPeerSSL.connect_to_stream].
		[b]Note:[/b] Not available in HTML5 exports.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="load">
			<return type="int" enum="Error" />
			<argument index="0" name="path" type="String" />
			<description>
				Loads a certificate from [code]path[/code] ("*.crt" file).
			</description>
		</method>
		<method name="save">
			<return type="int" enum="Error" />
			<argument index="0" name="path" type="String" />
			<description>
				Saves a certificate to the given [code]path[/code] (should be a "*.crt" file).
			</description>
		</method>
	</methods>
</class>