Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

CryptoKey

Inherits: Resource < RefCounted < Object

A cryptographic key (RSA).

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 Crypto.generate_self_signed_certificate and as private key in StreamPeerTLS.accept_stream along with the appropriate certificate.

Tutorials

Methods

bool

is_public_only() const

Error

load(path: String, public_only: bool = false)

Error

load_from_string(string_key: String, public_only: bool = false)

Error

save(path: String, public_only: bool = false)

String

save_to_string(public_only: bool = false)


Method Descriptions

bool is_public_only() const

Returns true if this CryptoKey only has the public part, and not the private one.


Error load(path: String, public_only: bool = false)

Loads a key from path. If public_only is true, only the public key will be loaded.

Note: path should be a "*.pub" file if public_only is true, a "*.key" file otherwise.


Error load_from_string(string_key: String, public_only: bool = false)

Loads a key from the given string_key. If public_only is true, only the public key will be loaded.


Error save(path: String, public_only: bool = false)

Saves a key to the given path. If public_only is true, only the public key will be saved.

Note: path should be a "*.pub" file if public_only is true, a "*.key" file otherwise.


String save_to_string(public_only: bool = false)

Returns a string containing the key in PEM format. If public_only is true, only the public key will be included.


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.