ucan/delegation/view.go

package delegation

import (
	"fmt"
	"time"

	"github.com/ipld/go-ipld-prime/datamodel"

	"github.com/ucan-wg/go-ucan/v1/capability/policy"
	"github.com/ucan-wg/go-ucan/v1/did"
)

type View struct {
	// Issuer DID (sender)
	Issuer did.DID
	// Audience DID (receiver)
	Audience did.DID
	// Principal that the chain is about (the Subject)
	Subject did.DID
	// The Command to eventually invoke
	Command string
	// The delegation policy
	Policy policy.Policy
	// A unique, random nonce
	Nonce []byte
	// Arbitrary Metadata
	Meta map[string]datamodel.Node
	// "Not before" UTC Unix Timestamp in seconds (valid from), 53-bits integer
	NotBefore time.Time
	// The timestamp at which the Invocation becomes invalid
	Expiration time.Time
}

// ViewFromModel build a decoded view of the raw IPLD data.
// This function also serves as validation.
func ViewFromModel(m PayloadModel) (*View, error) {
	var view View
	var err error

	view.Issuer, err = did.Parse(m.Iss)
	if err != nil {
		return nil, fmt.Errorf("parse iss: %w", err)
	}

	view.Audience, err = did.Parse(m.Aud)
	if err != nil {
		return nil, fmt.Errorf("parse audience: %w", err)
	}

	if m.Sub != nil {
		view.Subject, err = did.Parse(*m.Sub)
		if err != nil {
			return nil, fmt.Errorf("parse subject: %w", err)
		}
	} else {
		view.Subject = did.Undef
	}

	// TODO: make that a Command object, and validate it
	view.Command = m.Cmd

	// TODO: parsing + validation
	view.Policy = policy.Policy{}

	if len(m.Nonce) == 0 {
		return nil, fmt.Errorf("nonce is required")
	}
	view.Nonce = m.Nonce

	// TODO: copy?
	view.Meta = m.Meta.Values

	if m.Nbf != nil {
		view.NotBefore = time.Unix(*m.Nbf, 0)
	}

	if m.Exp != nil {
		view.Expiration = time.Unix(*m.Exp, 0)
	}

	return &view, nil
}

func (view *View) Capability() *Capability {
	return &Capability{
		Subject: view.Subject,
		Command: view.Command,
		Policy:  view.Policy,
	}
}

// Capability is a subset of a delegation formed by the triple (subject, command, policy).
// TODO: useful?
type Capability struct {
	// Principal that the chain is about (the Subject)
	Subject did.DID
	// The Command to eventually invoke
	Command string
	// The delegation policy
	Policy policy.Policy
}