HMACContext

package
v0.0.0-...-535787f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 23 Imported by: 0

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

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 Any

type Any interface {
	gd.IsClass
	AsHMACContext() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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 (self *Extension[T]) AsHMACContext() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

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 New

func New() Instance

func (Instance) AsHMACContext

func (self Instance) AsHMACContext() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) Finish

func (self Instance) Finish() []byte

Returns the resulting HMAC. If the HMAC failed, an empty []byte is returned.

func (Instance) ID

func (self Instance) ID() ID

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

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

func (self Instance) Update(data []byte) error

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.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL