Documentation
¶
Overview ¶
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.GenerateSelfSignedCertificate and as private key in StreamPeerTLS.AcceptStream along with the appropriate certificate.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- type ID
- type Instance
- func (self Instance) AsCryptoKey() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) ID() ID
- func (self Instance) IsPublicOnly() bool
- func (self Instance) Load(path string) error
- func (self Instance) LoadFromString(string_key string) error
- func (self Instance) MoreArgs() MoreArgs
- func (self Instance) Save(path string) error
- func (self Instance) SaveToString() string
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
- type MoreArgs
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsCryptoKey ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsCryptoKey ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) IsPublicOnly ¶
Returns true if this CryptoKey only has the public part, and not the private one.
func (Instance) Load ¶
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.
func (Instance) LoadFromString ¶
Loads a key from the given 'string_key'. If 'public_only' is true, only the public key will be loaded.
func (Instance) MoreArgs ¶
MoreArgs enables certain functions to be called with additional 'optional' arguments.
func (Instance) Save ¶
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.
func (Instance) SaveToString ¶
Returns a string containing the key in PEM format. If 'public_only' is true, only the public key will be included.
type MoreArgs ¶
MoreArgs is a container for Instance functions with additional 'optional' arguments.
func (MoreArgs) Load ¶
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.
func (MoreArgs) LoadFromString ¶
Loads a key from the given 'string_key'. If 'public_only' is true, only the public key will be loaded.
func (MoreArgs) Save ¶
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.
func (MoreArgs) SaveToString ¶
Returns a string containing the key in PEM format. If 'public_only' is true, only the public key will be included.
Source Files