feature/1110 abstract connected wallet operations (#1166)

- **refactor: refactor DID module types and move to controller package** - **refactor: move controller creation and resolution logic to keeper** - **refactor: update imports to reflect controller package move** - **refactor: update protobuf definitions for DID module** - **docs: update proto README to reflect changes** - **refactor: move hway to gateway, update node modules, and refactor pkl generation** - **build: update pkl-gen task to use new pkl file paths** - **refactor: refactor DWN WASM build and deployment process** - **refactor: refactor DID controller implementation to use account-based storage** - **refactor: move DID controller interface to base file and update implementation** - **chore: migrate to google protobuf** - **feat: Add v0.52.0 Interfaces for Acc Abstraction** - **refactor: replace public_key with public_key_hex in Assertion message** - **refactor: remove unused PubKey, JSONWebKey, and RawKey message types and related code**
2026-08-04 02:11:40 +00:00 · 2024-11-18 19:04:10 -05:00
parent 01cb37e82e
commit bf94277b0f
190 changed files with 9345 additions and 14038 deletions
@@ -0,0 +1,68 @@
+package ctx
+
+import (
+	"github.com/go-webauthn/webauthn/protocol"
+	"github.com/labstack/echo/v4"
+	"github.com/segmentio/ksuid"
+)
+
+// CookieKey is a type alias for string.
+type CookieKey string
+
+const (
+	// CookieKeySessionID is the key for the session ID cookie.
+	CookieKeySessionID CookieKey = "session.id"
+
+	// CookieKeySessionChal is the key for the session challenge cookie.
+	CookieKeySessionChal CookieKey = "session.chal"
+
+	// CookieKeySonrAddr is the key for the Sonr address cookie.
+	CookieKeySonrAddr CookieKey = "sonr.addr"
+
+	// CookieKeySonrDID is the key for the Sonr DID cookie.
+	CookieKeySonrDID CookieKey = "sonr.did"
+
+	// CookieKeyVaultCID is the key for the Vault CID cookie.
+	CookieKeyVaultCID CookieKey = "vault.cid"
+
+	// CookieKeyVaultSchema is the key for the Vault schema cookie.
+	CookieKeyVaultSchema CookieKey = "vault.schema"
+)
+
+// String returns the string representation of the CookieKey.
+func (c CookieKey) String() string {
+	return string(c)
+}
+
+// GetSessionID returns the session ID from the cookies.
+func GetSessionID(c echo.Context) string {
+	// Attempt to read the session ID from the "session" cookie
+	sessionID, err := ReadCookie(c, CookieKeySessionID)
+	if err != nil {
+		// Generate a new KSUID if the session cookie is missing or invalid
+		WriteCookie(c, CookieKeySessionID, ksuid.New().String())
+	}
+	return sessionID
+}
+
+// GetSessionChallenge returns the session challenge from the cookies.
+func GetSessionChallenge(c echo.Context) (*protocol.URLEncodedBase64, error) {
+	// TODO: Implement a way to regenerate the challenge if it is invalid.
+	chal := new(protocol.URLEncodedBase64)
+	// Attempt to read the session challenge from the "session" cookie
+	sessionChal, err := ReadCookie(c, CookieKeySessionChal)
+	if err != nil {
+		// Generate a new challenge if the session cookie is missing or invalid
+		ch, errb := protocol.CreateChallenge()
+		if errb != nil {
+			return nil, err
+		}
+		WriteCookie(c, CookieKeySessionChal, ch.String())
+		return &ch, nil
+	}
+	err = chal.UnmarshalJSON([]byte(sessionChal))
+	if err != nil {
+		return nil, err
+	}
+	return chal, nil
+}
@@ -0,0 +1,90 @@
+package ctx
+
+import (
+	"encoding/json"
+	"net/http"
+
+	"github.com/labstack/echo/v4"
+
+	"github.com/onsonr/sonr/pkg/motr/config"
+)
+
+// ╭───────────────────────────────────────────────────────────╮
+// │                  DWNContext struct methods                │
+// ╰───────────────────────────────────────────────────────────╯
+
+// DWNContext is the context for DWN endpoints.
+type DWNContext struct {
+	echo.Context
+
+	// Defaults
+	id string // Generated ksuid http cookie; Initialized on first request
+}
+
+// HasAuthorization returns true if the request has an Authorization header.
+func (s *DWNContext) HasAuthorization() bool {
+	v := ReadHeader(s.Context, HeaderAuthorization)
+	return v != ""
+}
+
+// ID returns the ksuid http cookie.
+func (s *DWNContext) ID() string {
+	return s.id
+}
+
+// Address returns the sonr address from the cookies.
+func (s *DWNContext) Address() string {
+	v, err := ReadCookie(s.Context, CookieKeySonrAddr)
+	if err != nil {
+		return ""
+	}
+	return v
+}
+
+// IPFSGatewayURL returns the IPFS gateway URL from the headers.
+func (s *DWNContext) IPFSGatewayURL() string {
+	return ReadHeader(s.Context, HeaderIPFSGatewayURL)
+}
+
+// ChainID returns the chain ID from the headers.
+func (s *DWNContext) ChainID() string {
+	return ReadHeader(s.Context, HeaderSonrChainID)
+}
+
+// Schema returns the vault schema from the cookies.
+func (s *DWNContext) Schema() *config.Schema {
+	v, err := ReadCookie(s.Context, CookieKeyVaultSchema)
+	if err != nil {
+		return nil
+	}
+	var schema config.Schema
+	err = json.Unmarshal([]byte(v), &schema)
+	if err != nil {
+		return nil
+	}
+	return &schema
+}
+
+// GetDWNContext returns the DWNContext from the echo context.
+func GetDWNContext(c echo.Context) (*DWNContext, error) {
+	ctx, ok := c.(*DWNContext)
+	if !ok {
+		return nil, echo.NewHTTPError(http.StatusInternalServerError, "DWN Context not found")
+	}
+	return ctx, nil
+}
+
+// HighwaySessionMiddleware establishes a Session Cookie.
+func DWNSessionMiddleware(config *config.Config) echo.MiddlewareFunc {
+	return func(next echo.HandlerFunc) echo.HandlerFunc {
+		return func(c echo.Context) error {
+			sessionID := GetSessionID(c)
+			injectConfig(c, config)
+			cc := &DWNContext{
+				Context: c,
+				id:      sessionID,
+			}
+			return next(cc)
+		}
+	}
+}
@@ -0,0 +1,45 @@
+package ctx
+
+import (
+	"net/http"
+
+	"github.com/labstack/echo/v4"
+)
+
+// ╭───────────────────────────────────────────────────────────╮
+// │                  HwayContext struct methods               │
+// ╰───────────────────────────────────────────────────────────╯
+
+// HwayContext is the context for Highway endpoints.
+type HwayContext struct {
+	echo.Context
+
+	// Defaults
+	id string // Generated ksuid http cookie; Initialized on first request
+}
+
+// ID returns the ksuid http cookie
+func (s *HwayContext) ID() string {
+	return s.id
+}
+
+// GetHwayContext returns the HwayContext from the echo context.
+func GetHWAYContext(c echo.Context) (*HwayContext, error) {
+	ctx, ok := c.(*HwayContext)
+	if !ok {
+		return nil, echo.NewHTTPError(http.StatusInternalServerError, "Highway Context not found")
+	}
+	return ctx, nil
+}
+
+// HighwaySessionMiddleware establishes a Session Cookie.
+func HighwaySessionMiddleware(next echo.HandlerFunc) echo.HandlerFunc {
+	return func(c echo.Context) error {
+		sessionID := GetSessionID(c)
+		cc := &HwayContext{
+			Context: c,
+			id:      sessionID,
+		}
+		return next(cc)
+	}
+}
@@ -0,0 +1,38 @@
+package ctx
+
+import (
+	"encoding/json"
+
+	"github.com/labstack/echo/v4"
+
+	dwngen "github.com/onsonr/sonr/pkg/motr/config"
+)
+
+type HeaderKey string
+
+const (
+	HeaderAuthorization HeaderKey = "Authorization"
+
+	HeaderIPFSGatewayURL HeaderKey = "X-IPFS-Gateway"
+	HeaderSonrChainID    HeaderKey = "X-Sonr-ChainID"
+	HeaderSonrKeyshare   HeaderKey = "X-Sonr-Keyshare"
+)
+
+func (h HeaderKey) String() string {
+	return string(h)
+}
+
+func injectConfig(c echo.Context, config *dwngen.Config) {
+	WriteHeader(c, HeaderIPFSGatewayURL, config.IpfsGatewayUrl)
+	WriteHeader(c, HeaderSonrChainID, config.SonrChainId)
+	WriteHeader(c, HeaderSonrKeyshare, config.MotrKeyshare)
+	WriteCookie(c, CookieKeySonrAddr, config.MotrAddress)
+
+	schemaBz, err := json.Marshal(config.VaultSchema)
+	if err != nil {
+		c.Logger().Error(err)
+		return
+	}
+
+	WriteCookie(c, CookieKeyVaultSchema, string(schemaBz))
+}
@@ -0,0 +1,35 @@
+package ctx
+
+// ╭───────────────────────────────────────────────────────────╮
+// │                      Request Headers                      │
+// ╰───────────────────────────────────────────────────────────╯
+
+type RequestHeaders struct {
+	CacheControl  *string `header:"Cache-Control"`
+	DeviceMemory  *string `header:"Device-Memory"`
+	From          *string `header:"From"`
+	Host          *string `header:"Host"`
+	Referer       *string `header:"Referer"`
+	UserAgent     *string `header:"User-Agent"`
+	ViewportWidth *string `header:"Viewport-Width"`
+	Width         *string `header:"Width"`
+
+	// HTMX Specific
+	HXBoosted               *string `header:"HX-Boosted"`
+	HXCurrentURL            *string `header:"HX-Current-URL"`
+	HXHistoryRestoreRequest *string `header:"HX-History-Restore-Request"`
+	HXPrompt                *string `header:"HX-Prompt"`
+	HXRequest               *string `header:"HX-Request"`
+	HXTarget                *string `header:"HX-Target"`
+	HXTriggerName           *string `header:"HX-Trigger-Name"`
+	HXTrigger               *string `header:"HX-Trigger"`
+}
+
+type ProtectedRequestHeaders struct {
+	Authorization      *string `header:"Authorization"`
+	Forwarded          *string `header:"Forwarded"`
+	Link               *string `header:"Link"`
+	PermissionsPolicy  *string `header:"Permissions-Policy"`
+	ProxyAuthorization *string `header:"Proxy-Authorization"`
+	WWWAuthenticate    *string `header:"WWW-Authenticate"`
+}
@@ -0,0 +1,38 @@
+package ctx
+
+import "github.com/go-webauthn/webauthn/protocol"
+
+type WebBytes = protocol.URLEncodedBase64
+
+// ╭───────────────────────────────────────────────────────────╮
+// │                     Response Headers                      │
+// ╰───────────────────────────────────────────────────────────╯
+
+type ResponseHeaders struct {
+	// HTMX Specific
+	HXLocation           *string `header:"HX-Location"`
+	HXPushURL            *string `header:"HX-Push-Url"`
+	HXRedirect           *string `header:"HX-Redirect"`
+	HXRefresh            *string `header:"HX-Refresh"`
+	HXReplaceURL         *string `header:"HX-Replace-Url"`
+	HXReswap             *string `header:"HX-Reswap"`
+	HXRetarget           *string `header:"HX-Retarget"`
+	HXReselect           *string `header:"HX-Reselect"`
+	HXTrigger            *string `header:"HX-Trigger"`
+	HXTriggerAfterSettle *string `header:"HX-Trigger-After-Settle"`
+	HXTriggerAfterSwap   *string `header:"HX-Trigger-After-Swap"`
+}
+
+type ProtectedResponseHeaders struct {
+	AcceptCH                      *string `header:"Accept-CH"`
+	AccessControlAllowCredentials *string `header:"Access-Control-Allow-Credentials"`
+	AccessControlAllowHeaders     *string `header:"Access-Control-Allow-Headers"`
+	AccessControlAllowMethods     *string `header:"Access-Control-Allow-Methods"`
+	AccessControlExposeHeaders    *string `header:"Access-Control-Expose-Headers"`
+	AccessControlRequestHeaders   *string `header:"Access-Control-Request-Headers"`
+	ContentSecurityPolicy         *string `header:"Content-Security-Policy"`
+	CrossOriginEmbedderPolicy     *string `header:"Cross-Origin-Embedder-Policy"`
+	PermissionsPolicy             *string `header:"Permissions-Policy"`
+	ProxyAuthorization            *string `header:"Proxy-Authorization"`
+	WWWAuthenticate               *string `header:"WWW-Authenticate"`
+}
@@ -0,0 +1,73 @@
+package ctx
+
+import (
+	"bytes"
+	"net/http"
+	"time"
+
+	"github.com/a-h/templ"
+	"github.com/labstack/echo/v4"
+)
+
+// ╭───────────────────────────────────────────────────────────╮
+// │                  Template Rendering                       │
+// ╰───────────────────────────────────────────────────────────╯
+
+func RenderTempl(c echo.Context, cmp templ.Component) error {
+	// Create a buffer to store the rendered HTML
+	buf := &bytes.Buffer{}
+	// Render the component to the buffer
+	err := cmp.Render(c.Request().Context(), buf)
+	if err != nil {
+		return err
+	}
+
+	// Set the content type
+	c.Response().Header().Set(echo.HeaderContentType, echo.MIMETextHTML)
+
+	// Write the buffered content to the response
+	_, err = c.Response().Write(buf.Bytes())
+	return err
+}
+
+// ╭──────────────────────────────────────────────────────────╮
+// │                  Cookie Management                       │
+// ╰──────────────────────────────────────────────────────────╯
+
+func ReadCookie(c echo.Context, key CookieKey) (string, error) {
+	cookie, err := c.Cookie(key.String())
+	if err != nil {
+		// Cookie not found or other error
+		return "", err
+	}
+	if cookie == nil || cookie.Value == "" {
+		// Cookie is empty
+		return "", http.ErrNoCookie
+	}
+	return cookie.Value, nil
+}
+
+func WriteCookie(c echo.Context, key CookieKey, value string) error {
+	cookie := &http.Cookie{
+		Name:     key.String(),
+		Value:    value,
+		Expires:  time.Now().Add(24 * time.Hour),
+		HttpOnly: true,
+		Path:     "/",
+		// Add Secure and SameSite attributes as needed
+	}
+	c.SetCookie(cookie)
+	return nil
+}
+
+// ╭────────────────────────────────────────────────────────╮
+// │                  HTTP Headers                          │
+// ╰────────────────────────────────────────────────────────╯
+
+func WriteHeader(c echo.Context, key HeaderKey, value string) {
+	c.Response().Header().Set(key.String(), value)
+}
+
+func ReadHeader(c echo.Context, key HeaderKey) string {
+	return c.Response().Header().Get(key.String())
+}