Table of Contents

Class CryptoKey

A cryptographic key (RSA or elliptic-curve).

Inheritance
CryptoKey

Remarks

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.

See Also

Methods

is_public_only

Qualifiers: const

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

bool is_public_only

load(String, bool)

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.

int load(String path, bool public_only)

Parameters

path String
public_only bool

load_from_string(String, bool)

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

int load_from_string(String string_key, bool public_only)

Parameters

string_key String
public_only bool

save(String, bool)

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.

int save(String path, bool public_only)

Parameters

path String
public_only bool

save_to_string(bool)

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

String save_to_string(bool public_only)

Parameters

public_only bool