mirror of
https://github.com/lightninglabs/lightning-terminal.git
synced 2026-08-13 12:33:36 +02:00
114 lines
2.9 KiB
Go
114 lines
2.9 KiB
Go
package session
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/btcsuite/btcd/btcec"
|
|
"github.com/lightninglabs/lightning-node-connect/mailbox"
|
|
"gopkg.in/macaroon-bakery.v2/bakery"
|
|
"gopkg.in/macaroon.v2"
|
|
)
|
|
|
|
// Type represents the type of session.
|
|
type Type uint8
|
|
|
|
const (
|
|
TypeMacaroonReadonly Type = 0
|
|
TypeMacaroonAdmin Type = 1
|
|
TypeMacaroonCustom Type = 2
|
|
TypeUIPassword Type = 3
|
|
)
|
|
|
|
// State represents the state of a session.
|
|
type State uint8
|
|
|
|
const (
|
|
StateCreated State = 0
|
|
StateInUse State = 1
|
|
StateRevoked State = 2
|
|
StateExpired State = 3
|
|
)
|
|
|
|
// MacaroonRecipe defines the permissions and caveats that should be used
|
|
// to bake a macaroon.
|
|
type MacaroonRecipe struct {
|
|
Permissions []bakery.Op
|
|
Caveats []macaroon.Caveat
|
|
}
|
|
|
|
// Session is a struct representing a long-term Terminal Connect session.
|
|
type Session struct {
|
|
Label string
|
|
State State
|
|
Type Type
|
|
Expiry time.Time
|
|
ServerAddr string
|
|
DevServer bool
|
|
MacaroonRootKey uint64
|
|
MacaroonRecipe *MacaroonRecipe
|
|
PairingSecret [mailbox.NumPassphraseEntropyBytes]byte
|
|
LocalPrivateKey *btcec.PrivateKey
|
|
LocalPublicKey *btcec.PublicKey
|
|
RemotePublicKey *btcec.PublicKey
|
|
}
|
|
|
|
// NewSession creates a new session with the given user-defined parameters.
|
|
func NewSession(label string, typ Type, expiry time.Time, serverAddr string,
|
|
devServer bool, perms []bakery.Op, caveats []macaroon.Caveat) (*Session,
|
|
error) {
|
|
|
|
_, pairingSecret, err := mailbox.NewPassphraseEntropy()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error deriving pairing secret: %v", err)
|
|
}
|
|
|
|
privateKey, err := btcec.NewPrivateKey(btcec.S256())
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error deriving private key: %v", err)
|
|
}
|
|
pubKey := privateKey.PubKey()
|
|
|
|
var macRootKeyBase [4]byte
|
|
copy(macRootKeyBase[:], pubKey.SerializeCompressed())
|
|
macRootKey := NewSuperMacaroonRootKeyID(macRootKeyBase)
|
|
|
|
sess := &Session{
|
|
Label: label,
|
|
State: StateCreated,
|
|
Type: typ,
|
|
Expiry: expiry,
|
|
ServerAddr: serverAddr,
|
|
DevServer: devServer,
|
|
MacaroonRootKey: macRootKey,
|
|
PairingSecret: pairingSecret,
|
|
LocalPrivateKey: privateKey,
|
|
LocalPublicKey: pubKey,
|
|
RemotePublicKey: nil,
|
|
}
|
|
|
|
if perms != nil || caveats != nil {
|
|
sess.MacaroonRecipe = &MacaroonRecipe{
|
|
Permissions: perms,
|
|
Caveats: caveats,
|
|
}
|
|
}
|
|
|
|
return sess, nil
|
|
}
|
|
|
|
// Store is the interface a persistent storage must implement for storing and
|
|
// retrieving Terminal Connect sessions.
|
|
type Store interface {
|
|
// StoreSession stores a session in the store. If a session with the
|
|
// same local public key already exists, the existing record is updated/
|
|
// overwritten instead.
|
|
StoreSession(*Session) error
|
|
|
|
// ListSessions returns all sessions currently known to the store.
|
|
ListSessions() ([]*Session, error)
|
|
|
|
// RevokeSession updates the state of the session with the given local
|
|
// public key to be revoked.
|
|
RevokeSession(*btcec.PublicKey) error
|
|
}
|