session: convert some NewSession params to functional ops

Author: ellemouton

session/interface.go

@@ -100,10 +100,9 @@ type Session struct {
 
 // buildSession creates a new session with the given user-defined parameters.
 func buildSession(id ID, localPrivKey *btcec.PrivateKey, label string, typ Type,
-	created, expiry time.Time, serverAddr string, devServer bool,
+	created, expiry time.Time, serverAddr string,
 	perms []bakery.Op, caveats []macaroon.Caveat,
-	featureConfig FeaturesConfig, privacy bool, linkedGroupID *ID,
-	flags PrivacyFlags, options ...Option) (*Session, error) {
+	options ...Option) (*Session, error) {
 
 	opts := defaultSessionOptions()
 	for _, o := range options {
@@ -120,10 +119,10 @@ func buildSession(id ID, localPrivKey *btcec.PrivateKey, label string, typ Type,
 	// The group ID will by default be the same as the Session ID
 	// unless this session links to a previous session.
 	groupID := id
-	if linkedGroupID != nil {
+	if opts.linkedGroupID != nil {
 		// If this session is linked to a previous session, then the
 		// group ID is the same as the linked session's group ID.
-		groupID = *linkedGroupID
+		groupID = *opts.linkedGroupID
 	}
 
 	sess := &Session{
@@ -134,14 +133,14 @@ func buildSession(id ID, localPrivKey *btcec.PrivateKey, label string, typ Type,
 		Expiry:            expiry.UTC(),
 		CreatedAt:         created.UTC(),
 		ServerAddr:        serverAddr,
-		DevServer:         devServer,
+		DevServer:         opts.devServer,
 		MacaroonRootKey:   macRootKey,
 		PairingSecret:     pairingSecret,
 		LocalPrivateKey:   localPrivKey,
 		LocalPublicKey:    localPrivKey.PubKey(),
 		RemotePublicKey:   nil,
-		WithPrivacyMapper: privacy,
-		PrivacyFlags:      flags,
+		WithPrivacyMapper: opts.privacy,
+		PrivacyFlags:      opts.privacyFlags,
 		GroupID:           groupID,
 	}
 
@@ -156,8 +155,8 @@ func buildSession(id ID, localPrivKey *btcec.PrivateKey, label string, typ Type,
 		}
 	}
 
-	if len(featureConfig) != 0 {
-		sess.FeatureConfig = &featureConfig
+	if len(opts.featureConfig) != 0 {
+		sess.FeatureConfig = &opts.featureConfig
 	}
 
 	return sess, nil
@@ -179,13 +178,36 @@ type sessionOptions struct {
 	// immediateActivation can be used to immediately move a session to
 	// the StateCreated state on creation.
 	immediateActivation bool
+
+	// privacy indicates if a privacy map should be used with this session.
+	privacy bool
+
+	// privacyFlags to use in combination with the session's privacy mapper.
+	privacyFlags PrivacyFlags
+
+	// featureConfig holds any feature configuration bytes to use for this
+	// session.
+	featureConfig FeaturesConfig
+
+	// linkedGroupID is the ID of the group that this session is linked
+	// to. By default, a session is not linked to another group.
+	linkedGroupID *ID
+
+	// devServer is true if TLS should be skipped when connecting to the
+	// mailbox server.
+	devServer bool
 }
 
 // defaultSessionOptions returns a new sessionOptions struct with default
 // values set.
 func defaultSessionOptions() *sessionOptions {
 	return &sessionOptions{
 		immediateActivation: false,
+		privacy:             false,
+		privacyFlags:        PrivacyFlags{},
+		featureConfig:       FeaturesConfig{},
+		linkedGroupID:       nil,
+		devServer:           false,
 	}
 }
 
@@ -201,16 +223,52 @@ func WithImmediateActivation() Option {
 	}
 }
 
+// WithPrivacy can be used to enable the privacy mapper for this session.
+func WithPrivacy(privacy bool) Option {
+	return func(o *sessionOptions) {
+		o.privacy = privacy
+	}
+}
+
+// WithPrivacyFlags can be used to set the privacy flags for this session.
+func WithPrivacyFlags(flags PrivacyFlags) Option {
+	return func(o *sessionOptions) {
+		o.privacyFlags = flags
+	}
+}
+
+// WithFeatureConfig can be used to set the feature configuration bytes for
+// this session.
+func WithFeatureConfig(config FeaturesConfig) Option {
+	return func(o *sessionOptions) {
+		o.featureConfig = config
+	}
+}
+
+// WithLinkedGroupID can be used to link this session to a previous session.
+func WithLinkedGroupID(groupID *ID) Option {
+	return func(o *sessionOptions) {
+		o.linkedGroupID = groupID
+	}
+}
+
+// WithDevServer can be used to set if TLS verification should be skipped when
+// connecting to the mailbox server.
+func WithDevServer(dev bool) Option {
+	return func(o *sessionOptions) {
+		o.devServer = dev
+	}
+}
+
 // Store is the interface a persistent storage must implement for storing and
 // retrieving Terminal Connect sessions.
 type Store interface {
 	// NewSession creates a new session with the given user-defined
 	// parameters. The session will remain in the StateReserved state until
 	// CreateSession is called for the session.
 	NewSession(label string, typ Type, expiry time.Time, serverAddr string,
-		devServer bool, perms []bakery.Op, caveats []macaroon.Caveat,
-		featureConfig FeaturesConfig, privacy bool, linkedGroupID *ID,
-		flags PrivacyFlags, opts ...Option) (*Session, error)
+		perms []bakery.Op, caveats []macaroon.Caveat,
+		opts ...Option) (*Session, error)
 
 	// CreateSession moves the given session from the StateReserved state to
 	// the StateCreated state.

session/kvdb_store.go

@@ -188,10 +188,8 @@ func getSessionKey(session *Session) []byte {
 //
 // NOTE: this is part of the Store interface.
 func (db *BoltStore) NewSession(label string, typ Type, expiry time.Time,
-	serverAddr string, devServer bool, perms []bakery.Op,
-	caveats []macaroon.Caveat, featureConfig FeaturesConfig, privacy bool,
-	linkedGroupID *ID, flags PrivacyFlags, options ...Option) (*Session,
-	error) {
+	serverAddr string, perms []bakery.Op,
+	caveats []macaroon.Caveat, options ...Option) (*Session, error) {
 
 	var session *Session
 	err := db.Update(func(tx *bbolt.Tx) error {
@@ -207,8 +205,8 @@ func (db *BoltStore) NewSession(label string, typ Type, expiry time.Time,
 
 		session, err = buildSession(
 			id, localPrivKey, label, typ, db.clock.Now(), expiry,
-			serverAddr, devServer, perms, caveats, featureConfig,
-			privacy, linkedGroupID, flags, options...,
+			serverAddr, perms, caveats,
+			options...,
 		)
 		if err != nil {
 			return err

session/store_test.go

@@ -329,8 +329,12 @@ func reserveSession(db Store, label string,
 
 	return db.NewSession(label, opts.sessType,
 		time.Date(99999, 1, 1, 0, 0, 0, 0, time.UTC),
-		"foo.bar.baz:1234", true, nil, nil, nil, true, opts.groupID,
-		[]PrivacyFlag{ClearPubkeys},
+		"foo.bar.baz:1234",
+		nil, nil,
+		WithDevServer(true),
+		WithPrivacy(true),
+		WithLinkedGroupID(opts.groupID),
+		WithPrivacyFlags(PrivacyFlags{ClearPubkeys}),
 	)
 }
 

session/tlv_test.go

@@ -134,9 +134,11 @@ func TestSerializeDeserializeSession(t *testing.T) {
 				time.Now(),
 				time.Date(99999, 1, 1, 0, 0, 0, 0, time.UTC),
 				"foo.bar.baz:1234", true, test.perms,
-				test.caveats, test.featureConfig, true,
-				test.linkedGroupID,
-				[]PrivacyFlag{ClearPubkeys},
+				test.caveats,
+				WithFeatureConfig(test.featureConfig),
+				WithPrivacy(true),
+				WithLinkedGroupID(test.linkedGroupID),
+				WithPrivacyFlags(PrivacyFlags{ClearPubkeys}),
 			)
 			require.NoError(t, err)
 
@@ -188,8 +190,7 @@ func TestGroupIDForOlderSessions(t *testing.T) {
 		id, priv, "test-session", TypeMacaroonAdmin,
 		time.Now(),
 		time.Date(99999, 1, 1, 0, 0, 0, 0, time.UTC),
-		"foo.bar.baz:1234", true, nil, nil, nil, false, nil,
-		PrivacyFlags{},
+		"foo.bar.baz:1234", true, nil, nil,
 	)
 	require.NoError(t, err)
 
@@ -224,8 +225,7 @@ func TestGroupID(t *testing.T) {
 		id, priv, "test-session", TypeMacaroonAdmin,
 		time.Now(),
 		time.Date(99999, 1, 1, 0, 0, 0, 0, time.UTC),
-		"foo.bar.baz:1234", true, nil, nil, nil, false, nil,
-		PrivacyFlags{},
+		"foo.bar.baz:1234", true, nil, nil,
 	)
 	require.NoError(t, err)
 
@@ -239,8 +239,8 @@ func TestGroupID(t *testing.T) {
 		id, priv, "test-session", TypeMacaroonAdmin,
 		time.Now(),
 		time.Date(99999, 1, 1, 0, 0, 0, 0, time.UTC),
-		"foo.bar.baz:1234", true, nil, nil, nil, false,
-		&session1.GroupID, PrivacyFlags{},
+		"foo.bar.baz:1234", true, nil, nil,
+		WithLinkedGroupID(&session1.GroupID),
 	)
 	require.NoError(t, err)
 

session_rpcserver.go

@@ -310,8 +310,8 @@ func (s *sessionRpcServer) AddSession(ctx context.Context,
 
 	sess, err := s.cfg.db.NewSession(
 		req.Label, typ, expiry, req.MailboxServerAddr,
-		req.DevServer, uniquePermissions, caveats, nil, false, nil,
-		session.PrivacyFlags{},
+		uniquePermissions, caveats,
+		session.WithDevServer(req.DevServer),
 		session.WithImmediateActivation(),
 	)
 	if err != nil {
@@ -1101,8 +1101,12 @@ func (s *sessionRpcServer) AddAutopilotSession(ctx context.Context,
 
 	sess, err := s.cfg.db.NewSession(
 		req.Label, session.TypeAutopilot, expiry,
-		req.MailboxServerAddr, req.DevServer, perms, caveats,
-		clientConfig, privacy, linkedGroupID, privacyFlags,
+		req.MailboxServerAddr, perms, caveats,
+		session.WithDevServer(req.DevServer),
+		session.WithFeatureConfig(clientConfig),
+		session.WithPrivacy(privacy),
+		session.WithPrivacyFlags(privacyFlags),
+		session.WithLinkedGroupID(linkedGroupID),
 	)
 	if err != nil {
 		return nil, fmt.Errorf("error creating new session: %v", err)