forked from TrueCloudLab/frostfs-sdk-go
130 lines
3.2 KiB
Go
130 lines
3.2 KiB
Go
package user
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/refs"
|
|
"github.com/mr-tron/base58"
|
|
"github.com/nspcc-dev/neo-go/pkg/crypto/hash"
|
|
"github.com/nspcc-dev/neo-go/pkg/encoding/address"
|
|
"github.com/nspcc-dev/neo-go/pkg/util"
|
|
)
|
|
|
|
const idSize = 25
|
|
|
|
var zeroSlice = bytes.Repeat([]byte{0}, idSize)
|
|
|
|
// ID identifies users of the FrostFS system.
|
|
//
|
|
// ID is mutually compatible with git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/refs.OwnerID
|
|
// message. See ReadFromV2 / WriteToV2 methods.
|
|
//
|
|
// Instances can be created using built-in var declaration. Zero ID is not valid,
|
|
// so it MUST be initialized using some modifying function (e.g. SetScriptHash,
|
|
// IDFromKey, etc.).
|
|
type ID struct {
|
|
w []byte
|
|
}
|
|
|
|
// ReadFromV2 reads ID from the refs.OwnerID message. Returns an error if
|
|
// the message is malformed according to the FrostFS API V2 protocol.
|
|
//
|
|
// See also WriteToV2.
|
|
func (x *ID) ReadFromV2(m refs.OwnerID) error {
|
|
w := m.GetValue()
|
|
if len(w) != idSize {
|
|
return fmt.Errorf("invalid length %d, expected %d", len(w), idSize)
|
|
}
|
|
|
|
if w[0] != address.NEO3Prefix {
|
|
return fmt.Errorf("invalid prefix byte 0x%X, expected 0x%X", w[0], address.NEO3Prefix)
|
|
}
|
|
|
|
if !bytes.Equal(w[21:], hash.Checksum(w[:21])) {
|
|
return errors.New("checksum mismatch")
|
|
}
|
|
|
|
x.w = w
|
|
|
|
return nil
|
|
}
|
|
|
|
// WriteToV2 writes ID to the refs.OwnerID message.
|
|
// The message must not be nil.
|
|
//
|
|
// See also ReadFromV2.
|
|
func (x ID) WriteToV2(m *refs.OwnerID) {
|
|
m.SetValue(x.w)
|
|
}
|
|
|
|
// SetScriptHash forms user ID from wallet address scripthash.
|
|
func (x *ID) SetScriptHash(scriptHash util.Uint160) {
|
|
if cap(x.w) < idSize {
|
|
x.w = make([]byte, idSize)
|
|
} else if len(x.w) < idSize {
|
|
x.w = x.w[:idSize]
|
|
}
|
|
|
|
x.w[0] = address.Prefix
|
|
copy(x.w[1:], scriptHash.BytesBE())
|
|
copy(x.w[21:], hash.Checksum(x.w[:21]))
|
|
}
|
|
|
|
// ScriptHash calculates and returns script hash of ID.
|
|
func (x *ID) ScriptHash() (util.Uint160, error) {
|
|
return util.Uint160DecodeBytesBE(x.w[1:21])
|
|
}
|
|
|
|
// WalletBytes returns FrostFS user ID as Neo3 wallet address in a binary format.
|
|
//
|
|
// Return value MUST NOT be mutated: to do this, first make a copy.
|
|
//
|
|
// See also Neo3 wallet docs.
|
|
func (x ID) WalletBytes() []byte {
|
|
return x.w
|
|
}
|
|
|
|
// EncodeToString encodes ID into FrostFS API V2 protocol string.
|
|
//
|
|
// See also DecodeString.
|
|
func (x ID) EncodeToString() string {
|
|
return base58.Encode(x.w)
|
|
}
|
|
|
|
// DecodeString decodes FrostFS API V2 protocol string. Returns an error
|
|
// if s is malformed.
|
|
//
|
|
// DecodeString always changes the ID.
|
|
//
|
|
// See also EncodeToString.
|
|
func (x *ID) DecodeString(s string) error {
|
|
var err error
|
|
|
|
x.w, err = base58.Decode(s)
|
|
if err != nil {
|
|
return fmt.Errorf("decode base58: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// String implements fmt.Stringer.
|
|
//
|
|
// String is designed to be human-readable, and its format MAY differ between
|
|
// SDK versions. String MAY return same result as EncodeToString. String MUST NOT
|
|
// be used to encode ID into FrostFS protocol string.
|
|
func (x ID) String() string {
|
|
return x.EncodeToString()
|
|
}
|
|
|
|
// Equals defines a comparison relation between two ID instances.
|
|
func (x ID) Equals(x2 ID) bool {
|
|
return bytes.Equal(x.w, x2.w)
|
|
}
|
|
|
|
// IsEmpty returns True, if ID is empty value.
|
|
func (x ID) IsEmpty() bool {
|
|
return bytes.Equal(zeroSlice, x.w)
|
|
}
|