Documentation
¶
Overview ¶
The HMACContext class is useful for advanced HMAC use cases, such as streaming the message as it supports creating the message over time rather than providing it all at once.
package main import ( "encoding/hex" "fmt" "graphics.gd/classdb/HMACContext" "graphics.gd/classdb/HashingContext" "graphics.gd/classdb/Node" ) type MyHMAC struct { Node.Extension[MyHMAC] ctx HMACContext.Instance } func (n *MyHMAC) Ready() { n.ctx = HMACContext.New() var key = []byte("supersecret") var err = n.ctx.Start(HashingContext.HashSha256, key) if err != nil { panic(err) } var msg1 = []byte("this is ") var msg2 = []byte("super duper secret") err = n.ctx.Update(msg1) if err != nil { panic(err) } err = n.ctx.Update(msg2) if err != nil { panic(err) } var hmac = n.ctx.Finish() fmt.Println(hex.EncodeToString(hmac)) }
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsHMACContext() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) Finish() []byte
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Start(hash_type HashingContext.HashType, key []byte) error
- func (self Instance) Update(data []byte) error
- func (self Instance) Virtual(name string) reflect.Value
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]) AsHMACContext ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
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 ¶
type Instance [1]gdclass.HMACContext
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) AsHMACContext ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) Finish ¶
Returns the resulting HMAC. If the HMAC failed, an empty []byte is returned.
func (Instance) Start ¶
func (self Instance) Start(hash_type HashingContext.HashType, key []byte) error
Initializes the HMACContext. This method cannot be called again on the same HMACContext until Instance.Finish has been called.
func (Instance) Update ¶
Updates the message to be HMACed. This can be called multiple times before Instance.Finish is called to append 'data' to the message, but cannot be called until Instance.Start has been called.