Struct gdnative_bindings_lily::Crypto [−][src]
pub struct Crypto { /* fields omitted */ }
Expand description
core class Crypto
inherits Reference
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
Crypto inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Generates a [PoolByteArray] of cryptographically secure random bytes with given size
.
Generates an RSA CryptoKey that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream].
pub fn generate_self_signed_certificate(
&self,
key: impl AsArg<CryptoKey>,
issuer_name: impl Into<GodotString>,
not_before: impl Into<GodotString>,
not_after: impl Into<GodotString>
) -> Option<Ref<X509Certificate, Shared>>
pub fn generate_self_signed_certificate(
&self,
key: impl AsArg<CryptoKey>,
issuer_name: impl Into<GodotString>,
not_before: impl Into<GodotString>,
not_after: impl Into<GodotString>
) -> Option<Ref<X509Certificate, Shared>>
Sample code is GDScript unless otherwise noted.
Generates a self-signed X509Certificate from the given CryptoKey and issuer_name
. The certificate validity will be defined by not_before
and not_after
(first valid date and last valid date). The issuer_name
must contain at least “CN=” (common name, i.e. the domain name), “O=” (organization, i.e. your company name), “C=” (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in).
A small example to generate an RSA key and a X509 self-signed certificate.
var crypto = Crypto.new()
# Generate 4096 bits RSA key.
var key = crypto.generate_rsa(4096)
# Generate self-signed certificate using the given key.
var cert = crypto.generate_self_signed_certificate(key, "CN=example.com,O=A Game Company,C=IT")
Default Arguments
issuer_name
-"CN=myserver,O=myorganisation,C=IT"
not_before
-"20140101000000"
not_after
-"20340101000000"
Methods from Deref<Target = Reference>
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Crypto
impl UnwindSafe for Crypto