Tweak godocs for lib/common
This commit is contained in:
@@ -1,3 +1,34 @@
|
||||
// Package session_key implements the I2P SessionKey common data structure
|
||||
package session_key
|
||||
|
||||
/*
|
||||
[SessionKey]
|
||||
Accurate for version 0.9.49
|
||||
|
||||
Description
|
||||
This structure is used for symmetric AES256 encryption and decryption.
|
||||
|
||||
Contents
|
||||
32 bytes
|
||||
*/
|
||||
|
||||
// SessionKey is the represenation of an I2P SessionKey.
|
||||
//
|
||||
// https://geti2p.net/spec/common-structures#sessionkey
|
||||
type SessionKey [32]byte
|
||||
|
||||
// ReadSessionKey returns SessionKey from a []byte.
|
||||
// The remaining bytes after the specified length are also returned.
|
||||
// Returns a list of errors that occurred during parsing.
|
||||
func ReadSessionKey(bytes []byte) (info SessionKey, remainder []byte, err error) {
|
||||
// TODO: stub
|
||||
return
|
||||
}
|
||||
|
||||
// NewSessionKey creates a new *SessionKey from []byte using ReadSessionKey.
|
||||
// Returns a pointer to SessionKey unlike ReadSessionKey.
|
||||
func NewSessionKey(data []byte) (session_key *SessionKey, remainder []byte, err error) {
|
||||
sessionKey, remainder, err := ReadSessionKey(data)
|
||||
session_key = &sessionKey
|
||||
return
|
||||
}
|
||||
|
Reference in New Issue
Block a user