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 StreamPeerSSL.accept_stream along with the appropriate certificate.

Note: Not available in HTML5 exports.

Methods

bool

is_public_only ( ) const

Error

load ( String path, bool public_only=false )

Error

load_from_string ( String string_key, bool public_only=false )

Error

save ( String path, bool public_only=false )

String

save_to_string ( bool public_only=false )

Method Descriptions

  • bool is_public_only ( ) const

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


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.


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


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 ( bool public_only=false )

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