Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

shared

package

Go to main page

Versions in this module

v0

v0.8.1

May 5, 2026

v0.8.0

May 1, 2026

v0.4.1

May 1, 2026

retracted

Changes in this version

+ const FingerprintLength

+ const KeyIDLength

+ const NonceSize

+ const PrivateKeySize

+ const PublicKeySize

+ const RoleAdmin

+ const RoleDeployer

+ const RoleOwner

+ const RoleReader

+ const SharedKeySize

+ const SignatureSize

+ const Version

+ var Commit = "unknown"

+ var ErrAuthKeyNotInitialized = errors.New("auth: WebSocket auth key not initialized")

+ var ErrEmptyClientID = errors.New("auth: empty client ID")

+ var ErrInvalidAudience = errors.New("auth: invalid audience")

+ var ErrInvalidClientID = errors.New("auth: invalid client ID")

+ var ErrInvalidSigningMethod = errors.New("auth: invalid signing method")

+ var ErrInvalidToken = errors.New("auth: invalid token")

+ var ErrKeyMismatch = errors.New("auth: key ID mismatch")

+ var ErrNilKey = errors.New("crypto: nil key provided")

+ var SharedLogger = PackageLogger("shared", "🔗 SHARED")

+ func CreateTarGz(srcDir, targetTar string) error

+ func CreateZip(srcDir, targetZip string) error

+ func DecodeFromBase64(encoded string) ([]byte, error)

+ func DecodeFromHex(encoded string) ([]byte, error)

+ func Decrypt(cipherText []byte, key []byte, nonce []byte) ([]byte, error) — darwin/amd64, js/wasm, linux/amd64

+ func DecryptMessage(key []byte, data []byte) ([]byte, uint64, error)

+ func DeriveSharedKey(privateKey *ecdh.PrivateKey, publicKey *ecdh.PublicKey) ([]byte, error) — darwin/amd64, js/wasm, linux/amd64

+ func DeserializeFromJSON(jsonStr string, data interface{}) error

+ func EncodeToBase64(data []byte) string

+ func EncodeToHex(data []byte) string

+ func Encrypt(data []byte, key []byte) ([]byte, []byte, error) — darwin/amd64, js/wasm, linux/amd64

+ func EncryptMessage(key []byte, sequence uint64, payload interface{}) ([]byte, error)

+ func ExtractTarGz(src, dest string) error

+ func GenerateCommandID() string

+ func GenerateFingerprint(publicKey ed25519.PublicKey) (string, error) — darwin/amd64, js/wasm, linux/amd64

+ func GetCurrentTimestamp() int64

+ func HasRequiredRole(role Identity, Role string) bool

+ func LoadKeyFromFile(filename string) ([]byte, error) — darwin/amd64, js/wasm, linux/amd64

+ func RunCryptoHealthChecks() error — darwin/amd64, js/wasm, linux/amd64

+ func SecureKeyMemory(key []byte)

+ func SerializeToJSON(data interface{}) (string, error)

+ func Sign(data []byte, privateKey ed25519.PrivateKey) ([]byte, error) — darwin/amd64, js/wasm, linux/amd64

+ func ValidateKeyID(keyID string) error

+ func Verify(data []byte, signature []byte, publicKey ed25519.PublicKey) (bool, error) — darwin/amd64, js/wasm, linux/amd64

+ func VerifyMessageSignature(msg AgentMessage) bool — darwin/amd64, js/wasm, linux/amd64

+ func ZeroKey(key []byte)

+ type AgentMessage struct

+ AgentID string

+ Context map[string]string

+ Payload json.RawMessage

+ Signature string

+ Source AgentType

+ Target AgentType

+ Timestamp int64

+ Type MessageType

+ func NewCommandMessage(agentID string, command CommandPayload) (AgentMessage, error)

+ func NewStatusMessage(agentID string, status StatusPayload) (AgentMessage, error)

+ func SignMessage(msg AgentMessage, privateKey *ecdsa.PrivateKey) (AgentMessage, error)

+ type AgentType string

+ const AgentCLI

+ const AgentDaemon

+ const AgentDashboard

+ type AuditLogEntry struct

+ Action string

+ Actor string

+ Client string

+ IP string

+ Message string

+ Signature string

+ Target string

+ Timestamp time.Time

+ type AuthPayload struct

+ Hostname string

+ Token string

+ Version string

+ type CommandPayload struct

+ Args []string

+ ID string

+ Meta interface{}

+ Name string

+ type ECCSignature struct

+ R *big.Int

+ S *big.Int

+ type EncryptedEnv struct

+ CLIPublicKey string

+ EnvBlob string

+ KeyID string

+ Nonce string

+ Timestamp time.Time

+ Variables map[string]string

+ type EnvFile struct

+ Raw []byte

+ Variables map[string]string

+ func ParseEnvFile(content []byte) (*EnvFile, error)

+ type Envelope struct

+ Payload []byte

+ Signature string

+ type ErrorPayload struct

+ Code int

+ Details string

+ Message string

+ type EventPayload struct

+ Data interface{}

+ Type string

+ type Identity struct

+ AddedBy string

+ CreatedAt time.Time

+ Email string

+ Fingerprint string

+ PublicKey string

+ Role string

+ SignPublic string

+ type KeyPair struct

+ ECDHPrivate *ecdh.PrivateKey

+ ECDHPublic *ecdh.PublicKey

+ ECDSAKey *ecdsa.PrivateKey

+ KeyID string

+ SignPrivate ed25519.PrivateKey

+ SignPublic ed25519.PublicKey

+ func GenerateKeyPair() (*KeyPair, error)

+ type LogLevel int

+ const LevelDebug

+ const LevelError

+ const LevelFatal

+ const LevelInfo

+ const LevelSuccess

+ const LevelTrace

+ const LevelWarn

+ type Logger struct

+ func DefaultLogger() *Logger

+ func New(out io.Writer, prefix string, flag int, minLevel LogLevel) *Logger

+ func PackageLogger(pkgName string, displayName string) *Logger

+ func (l *Logger) Debug(msg string, args ...interface{})

+ func (l *Logger) EnableBanner(enable bool)

+ func (l *Logger) EnableCallerInfo(enable bool)

+ func (l *Logger) EnableColor(enable bool)

+ func (l *Logger) EnableTimestamp(enable bool)

+ func (l *Logger) Error(msg string, args ...interface{})

+ func (l *Logger) Fatal(msg string, args ...interface{})

+ func (l *Logger) Indent() *Logger

+ func (l *Logger) Info(msg string, args ...interface{})

+ func (l *Logger) JSON(level LogLevel, data interface{})

+ func (l *Logger) Log(level LogLevel, msg string, args ...interface{})

+ func (l *Logger) Progress(level LogLevel, current, total int, label string)

+ func (l *Logger) RegisterPackage(pkg string, displayName string)

+ func (l *Logger) SetLevel(level LogLevel)

+ func (l *Logger) SetOutput(w io.Writer)

+ func (l *Logger) SetTimeFormat(format string)

+ func (l *Logger) Success(msg string, args ...interface{})

+ func (l *Logger) Table(level LogLevel, headers []string, rows [][]string)

+ func (l *Logger) Timed(label string, fn func())

+ func (l *Logger) Trace(msg string, args ...interface{})

+ func (l *Logger) Warn(msg string, args ...interface{})

+ func (l *Logger) WithPrefix(prefix string) *Logger

+ type MessageHeader struct

+ SessionID string

+ Type string

+ type MessageType string

+ const TypeAuth

+ const TypeAuthResponse

+ const TypeCommand

+ const TypeCommandResponse

+ const TypeError

+ const TypeEvent

+ const TypeLog

+ const TypeResponse

+ const TypeStatus

+ const TypeStatusAck

+ type PublicKeyResponse struct

+ KeyID string

+ PublicKey string

+ SignPublic string

+ type SecureMessage struct

+ Ciphertext []byte

+ IV []byte

+ Sequence uint64

+ Tag []byte

+ Timestamp int64

+ type StatusPayload struct

+ Load SystemLoad

+ Metrics map[string]interface{}

+ Status string

+ type SystemLoad struct

+ CPU float64

+ Disk float64

+ Memory float64

+ type TrustStore struct

+ Identities []Identity

+ Keys []TrustedKey

+ type TrustedKey struct

+ Fingerprint string

+ KeyID string

+ PublicKey *ecdh.PublicKey

+ SignPublic string