Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

17.1 KB
Raw Blame
package entitlements

import (
	"crypto/ed25519"
	"crypto/rand"
	"encoding/hex"
	"errors"
	"fmt"
	"strings"
	"time"

	"github.com/golang-jwt/jwt/v5"
	"github.com/rcourtman/pulse-go-rewrite/internal/cloudcp/registry"
	pkglicensing "github.com/rcourtman/pulse-go-rewrite/pkg/licensing"
)

const defaultCloudPlanVersion = "cloud_starter"

var (
	ErrHostedEntitlementNotFound       = errors.New("hosted entitlement not found")
	ErrHostedEntitlementTargetMismatch = errors.New("hosted entitlement target mismatch")
	ErrHostedEntitlementInactive       = errors.New("hosted entitlement inactive")
	ErrHostedEntitlementInvalid        = errors.New("hosted entitlement is invalid")
)

type Service struct {
	registry                  *registry.TenantRegistry
	baseURL                   string
	trialActivationPrivateKey string
	providerLicense           string
	// providerHosted records that this control plane runs on a provider's own
	// infrastructure, independently of whether a licence happens to be
	// present. The capability ceiling follows hosting, not licensing: a
	// provider deployment cannot back relay, mobile or push whether it is
	// licensed or not, so it must never mint leases claiming them.
	providerHosted bool
	now            func() time.Time
}

type RefreshResult struct {
	EntitlementJWT string
}

func NewService(reg *registry.TenantRegistry, baseURL, trialActivationPrivateKey string) *Service {
	return &Service{
		registry:                  reg,
		baseURL:                   strings.TrimSpace(baseURL),
		trialActivationPrivateKey: strings.TrimSpace(trialActivationPrivateKey),
		now:                       func() time.Time { return time.Now().UTC() },
	}
}

func (s *Service) SetNow(now func() time.Time) {
	if s == nil || now == nil {
		return
	}
	s.now = func() time.Time { return now().UTC() }
}

// SetProviderLicense chains the Pulse-signed provider MSP license into every
// lease this service signs. Release-build client runtimes only trust lease
// signing keys bound into such a license, so provider-hosted control planes
// must set this for their leases to verify.
func (s *Service) SetProviderLicense(licenseKey string) {
	if s == nil {
		return
	}
	s.providerLicense = strings.TrimSpace(licenseKey)
}

// SetProviderHosted marks this control plane as provider-operated, which bounds
// the capabilities its leases may claim.
//
// This is separate from SetProviderLicense on purpose. Deriving the ceiling
// from licence presence meant an unlicensed provider deployment fell through to
// the Pulse-hosted branch and minted leases claiming relay, mobile and push,
// which a provider deployment cannot serve and which previously produced
// repeating relay registration failures in client runtimes.
func (s *Service) SetProviderHosted(providerHosted bool) {
	if s == nil {
		return
	}
	s.providerHosted = providerHosted
}

func (s *Service) IssueTenantBillingState(tenant *registry.Tenant, requestedSubState pkglicensing.SubscriptionState, requestedPlanVersion, stripeCustomerID, stripeSubscriptionID, stripePriceID string) (*pkglicensing.BillingState, error) {
	if s == nil || s.registry == nil {
		return nil, fmt.Errorf("hosted entitlement service is unavailable")
	}
	if tenant == nil {
		return nil, fmt.Errorf("tenant is nil")
	}

	ctx, err := s.resolveTenantLeaseContext(tenant, requestedSubState, requestedPlanVersion)
	if err != nil {
		return nil, err
	}
	if !pkglicensing.ShouldGrantPaidCapabilities(ctx.subscriptionState) {
		return &pkglicensing.BillingState{
			Capabilities:         []string{},
			Limits:               map[string]int64{},
			MetersEnabled:        []string{},
			PlanVersion:          strings.TrimSpace(ctx.planVersion),
			SubscriptionState:    ctx.subscriptionState,
			StripeCustomerID:     strings.TrimSpace(stripeCustomerID),
			StripeSubscriptionID: strings.TrimSpace(stripeSubscriptionID),
			StripePriceID:        strings.TrimSpace(stripePriceID),
		}, nil
	}

	refreshToken, err := s.ensurePaidRefreshToken(tenant.ID)
	if err != nil {
		return nil, fmt.Errorf("issue hosted entitlement refresh token: %w", err)
	}
	entitlementJWT, err := s.signPaidLease(ctx, tenantInstanceHost(s.baseURL, tenant.ID), s.now().UTC())
	if err != nil {
		return nil, err
	}

	return &pkglicensing.BillingState{
		Capabilities:            []string{},
		Limits:                  map[string]int64{},
		MetersEnabled:           []string{},
		EntitlementJWT:          entitlementJWT,
		EntitlementRefreshToken: refreshToken,
		StripeCustomerID:        strings.TrimSpace(stripeCustomerID),
		StripeSubscriptionID:    strings.TrimSpace(stripeSubscriptionID),
		StripePriceID:           strings.TrimSpace(stripePriceID),
	}, nil
}

func (s *Service) RefreshEntitlement(refreshToken, instanceHost string) (*RefreshResult, error) {
	if s == nil || s.registry == nil {
		return nil, fmt.Errorf("hosted entitlement service is unavailable")
	}
	refreshToken = strings.TrimSpace(refreshToken)
	instanceHost = strings.ToLower(strings.TrimSpace(instanceHost))
	if refreshToken == "" {
		return nil, ErrHostedEntitlementNotFound
	}
	if instanceHost == "" {
		return nil, ErrHostedEntitlementTargetMismatch
	}

	entitlement, err := s.registry.GetHostedEntitlementByRefreshToken(refreshToken)
	if err != nil {
		return nil, err
	}
	if entitlement == nil {
		return nil, ErrHostedEntitlementNotFound
	}
	if entitlement.RevokedAt != nil {
		return nil, ErrHostedEntitlementInactive
	}

	switch entitlement.Kind {
	case "", registry.HostedEntitlementKindPaid:
		return s.refreshPaidEntitlement(entitlement, instanceHost)
	case registry.HostedEntitlementKindTrial:
		return s.refreshTrialEntitlement(entitlement, instanceHost)
	default:
		return nil, ErrHostedEntitlementNotFound
	}
}

func (s *Service) RevokeTenantEntitlement(tenantID string, revokedAt time.Time) error {
	if s == nil || s.registry == nil {
		return fmt.Errorf("hosted entitlement service is unavailable")
	}
	return s.registry.RevokeHostedEntitlement(tenantID, revokedAt)
}

type tenantLeaseContext struct {
	tenant            *registry.Tenant
	stripeAccount     *registry.StripeAccount
	subscriptionState pkglicensing.SubscriptionState
	planVersion       string
	// providerChained records that a Pulse-signed provider licence is
	// available to embed, which is what lets release builds verify the lease.
	providerChained bool
	// providerHosted records that this control plane runs on the provider's
	// own infrastructure, which is what bounds the capability ceiling.
	providerHosted bool
}

type trialEntitlementContext struct {
	requestID      string
	orgID          string
	email          string
	instanceHost   string
	trialStartedAt time.Time
}

func (s *Service) refreshPaidEntitlement(entitlement *registry.HostedEntitlement, instanceHost string) (*RefreshResult, error) {
	if entitlement == nil {
		return nil, ErrHostedEntitlementNotFound
	}
	tenant, err := s.registry.Get(entitlement.TenantID)
	if err != nil {
		return nil, err
	}
	if tenant == nil {
		return nil, ErrHostedEntitlementNotFound
	}
	if tenant.State != registry.TenantStateActive {
		return nil, ErrHostedEntitlementInactive
	}

	expectedInstanceHost := tenantInstanceHost(s.baseURL, tenant.ID)
	if expectedInstanceHost == "" || instanceHost != expectedInstanceHost {
		return nil, ErrHostedEntitlementTargetMismatch
	}

	ctx, err := s.resolveTenantLeaseContext(tenant, "", "")
	if err != nil {
		return nil, err
	}
	if !pkglicensing.ShouldGrantPaidCapabilities(ctx.subscriptionState) {
		return nil, ErrHostedEntitlementInactive
	}

	now := s.now().UTC()
	entitlementJWT, err := s.signPaidLease(ctx, expectedInstanceHost, now)
	if err != nil {
		return nil, err
	}
	if err := s.registry.MarkHostedEntitlementRefreshed(entitlement.ID, now); err != nil {
		return nil, err
	}
	return &RefreshResult{EntitlementJWT: entitlementJWT}, nil
}

func (s *Service) refreshTrialEntitlement(entitlement *registry.HostedEntitlement, instanceHost string) (*RefreshResult, error) {
	if entitlement == nil {
		return nil, ErrHostedEntitlementNotFound
	}
	if entitlement.RedeemedAt == nil || entitlement.TrialStartedAt == nil {
		return nil, ErrHostedEntitlementInactive
	}
	expectedInstanceHost := strings.ToLower(strings.TrimSpace(entitlement.InstanceHost))
	if expectedInstanceHost == "" || instanceHost != expectedInstanceHost {
		return nil, ErrHostedEntitlementTargetMismatch
	}

	now := s.now().UTC()
	ctx := trialEntitlementContext{
		requestID:      strings.TrimSpace(entitlement.TrialRequestID),
		orgID:          strings.TrimSpace(entitlement.OrgID),
		email:          strings.TrimSpace(entitlement.Email),
		instanceHost:   expectedInstanceHost,
		trialStartedAt: entitlement.TrialStartedAt.UTC(),
	}
	claims := buildTrialLeaseClaims(ctx, now)
	if claims.TrialEndsAt == nil || now.Unix() >= *claims.TrialEndsAt {
		return nil, ErrHostedEntitlementInactive
	}
	entitlementJWT, err := s.signTrialLease(ctx, now)
	if err != nil {
		return nil, err
	}
	if err := s.registry.MarkHostedEntitlementRefreshed(entitlement.ID, now); err != nil {
		return nil, err
	}
	return &RefreshResult{EntitlementJWT: entitlementJWT}, nil
}

func (s *Service) resolveTenantLeaseContext(tenant *registry.Tenant, requestedSubState pkglicensing.SubscriptionState, requestedPlanVersion string) (*tenantLeaseContext, error) {
	if tenant == nil {
		return nil, fmt.Errorf("tenant is nil")
	}

	ctx := &tenantLeaseContext{
		tenant:            tenant,
		subscriptionState: requestedSubState,
		planVersion:       pkglicensing.CanonicalizePlanVersion(requestedPlanVersion),
		providerChained:   strings.TrimSpace(s.providerLicense) != "",
		providerHosted:    s.providerHosted,
	}
	if ctx.planVersion == "" {
		ctx.planVersion = pkglicensing.CanonicalizePlanVersion(tenant.PlanVersion)
	}

	if strings.TrimSpace(tenant.AccountID) != "" {
		stripeAccount, err := s.registry.GetStripeAccount(tenant.AccountID)
		if err != nil {
			return nil, fmt.Errorf("load stripe account for tenant %s: %w", tenant.ID, err)
		}
		ctx.stripeAccount = stripeAccount
		if ctx.planVersion == "" && stripeAccount != nil && strings.TrimSpace(stripeAccount.PlanVersion) != "" {
			ctx.planVersion = pkglicensing.CanonicalizePlanVersion(stripeAccount.PlanVersion)
		}
		if ctx.subscriptionState == "" && stripeAccount != nil {
			// stripeAccount.SubscriptionState holds the normalized stored form
			// (e.g. "trial", "past_due") written by
			// normalizeStripeAccountSubscriptionState; use the stored-form
			// parser, not the raw Stripe-status mapper.
			ctx.subscriptionState = pkglicensing.ParseStoredSubscriptionState(stripeAccount.SubscriptionState)
			if ctx.subscriptionState == pkglicensing.SubStateTrial && stripeAccount.TrialEndsAt == nil {
				ctx.subscriptionState = pkglicensing.SubStateActive
			}
		}
		if ctx.planVersion == "" {
			account, err := s.registry.GetAccount(tenant.AccountID)
			if err != nil {
				return nil, fmt.Errorf("load account for tenant %s: %w", tenant.ID, err)
			}
			if account != nil && account.Kind == registry.AccountKindMSP {
				ctx.planVersion = "msp_starter"
			}
		}
	}

	if ctx.planVersion == "" {
		ctx.planVersion = defaultCloudPlanVersion
	}
	if ctx.subscriptionState == "" {
		ctx.subscriptionState = tenantSubscriptionState(tenant)
	}
	return ctx, nil
}

func (s *Service) ensurePaidRefreshToken(tenantID string) (string, error) {
	rawToken, err := randomRefreshToken()
	if err != nil {
		return "", err
	}
	storedToken, _, err := s.registry.StoreOrIssueHostedEntitlement(tenantID, rawToken, s.now().UTC())
	if err != nil {
		return "", err
	}
	return storedToken, nil
}

func (s *Service) signPaidLease(ctx *tenantLeaseContext, instanceHost string, now time.Time) (string, error) {
	privateKey, err := s.entitlementPrivateKey()
	if err != nil {
		return "", err
	}
	claims := buildPaidEntitlementLeaseClaims(ctx, instanceHost, now)
	claims.ProviderLicense = s.providerLicense
	signed, err := pkglicensing.SignEntitlementLeaseToken(privateKey, claims)
	if err != nil {
		return "", fmt.Errorf("sign hosted entitlement lease: %w", err)
	}
	return signed, nil
}

func (s *Service) signTrialLease(ctx trialEntitlementContext, now time.Time) (string, error) {
	privateKey, err := s.entitlementPrivateKey()
	if err != nil {
		return "", err
	}
	claims := buildTrialLeaseClaims(ctx, now)
	signed, err := pkglicensing.SignEntitlementLeaseToken(privateKey, claims)
	if err != nil {
		return "", fmt.Errorf("sign hosted trial entitlement lease: %w", err)
	}
	return signed, nil
}

func (s *Service) entitlementPrivateKey() (ed25519.PrivateKey, error) {
	privateKey, err := pkglicensing.DecodeEd25519PrivateKey(strings.TrimSpace(s.trialActivationPrivateKey))
	if err != nil {
		return nil, fmt.Errorf("decode hosted entitlement signing key: %w", err)
	}
	return privateKey, nil
}

func randomRefreshToken() (string, error) {
	raw := make([]byte, 24)
	if _, err := rand.Read(raw); err != nil {
		return "", fmt.Errorf("generate entitlement refresh token: %w", err)
	}
	return "etr_hosted_" + hex.EncodeToString(raw), nil
}

func isMSPPlanVersion(planVersion string) bool {
	return strings.HasPrefix(strings.ToLower(strings.TrimSpace(planVersion)), "msp_")
}

func tenantSubscriptionState(tenant *registry.Tenant) pkglicensing.SubscriptionState {
	if tenant == nil {
		return pkglicensing.SubStateExpired
	}
	switch tenant.State {
	case registry.TenantStateSuspended:
		return pkglicensing.SubStateSuspended
	case registry.TenantStateCanceled, registry.TenantStateDeleted, registry.TenantStateDeleting:
		return pkglicensing.SubStateCanceled
	default:
		return pkglicensing.SubStateActive
	}
}

func buildPaidEntitlementLeaseClaims(ctx *tenantLeaseContext, instanceHost string, now time.Time) pkglicensing.EntitlementLeaseClaims {
	var capabilities []string
	if pkglicensing.ShouldGrantPaidCapabilities(ctx.subscriptionState) {
		switch {
		case isMSPPlanVersion(ctx.planVersion) && ctx.providerHosted:
			// Provider-hosted MSP client workspaces lease the chained
			// ceiling: MSP tier plus white_label (branded per-client
			// reports), minus Pulse-service-backed capabilities (relay,
			// mobile, push) the provider deployment cannot grant. Mirrors
			// the chain-verification cap in pkg/licensing.
			capabilities = pkglicensing.ProviderChainedLeaseCapabilities()
		case isMSPPlanVersion(ctx.planVersion):
			// Pulse-hosted MSP workspaces run against Pulse-operated
			// services, so they keep the full MSP tier set.
			capabilities = pkglicensing.DeriveCapabilitiesFromTier(pkglicensing.TierMSP, []string{pkglicensing.FeatureWhiteLabel})
		default:
			capabilities = pkglicensing.DeriveCapabilitiesFromTier(pkglicensing.TierCloud, nil)
		}
	}
	claims := pkglicensing.EntitlementLeaseClaims{
		OrgID:             "default",
		Email:             strings.TrimSpace(ctx.tenant.Email),
		InstanceHost:      instanceHost,
		PlanVersion:       strings.TrimSpace(ctx.planVersion),
		SubscriptionState: ctx.subscriptionState,
		Capabilities:      capabilities,
		Limits:            map[string]int64{},
		MetersEnabled:     []string{},
		RegisteredClaims: jwt.RegisteredClaims{
			IssuedAt:  jwt.NewNumericDate(now.UTC()),
			ExpiresAt: jwt.NewNumericDate(now.UTC().Add(24 * time.Hour)),
		},
	}
	if ctx.stripeAccount != nil && ctx.subscriptionState == pkglicensing.SubStateTrial && ctx.stripeAccount.TrialEndsAt != nil && *ctx.stripeAccount.TrialEndsAt > 0 {
		trialEndsAt := *ctx.stripeAccount.TrialEndsAt
		claims.TrialEndsAt = &trialEndsAt
		claims.ExpiresAt = jwt.NewNumericDate(time.Unix(trialEndsAt, 0).UTC())
	}
	return claims
}

func buildTrialLeaseClaims(ctx trialEntitlementContext, now time.Time) pkglicensing.EntitlementLeaseClaims {
	trialCapabilities, trialLimits := pkglicensing.DeriveEntitlements(
		pkglicensing.TierPro,
		nil,
		0,
		0,
	)
	trialState := pkglicensing.BuildTrialBillingState(ctx.trialStartedAt.UTC(), trialCapabilities)
	return pkglicensing.EntitlementLeaseClaims{
		OrgID:             strings.TrimSpace(ctx.orgID),
		Email:             strings.TrimSpace(ctx.email),
		InstanceHost:      strings.TrimSpace(ctx.instanceHost),
		PlanVersion:       trialState.PlanVersion,
		SubscriptionState: trialState.SubscriptionState,
		Capabilities:      append([]string(nil), trialState.Capabilities...),
		Limits:            trialLimits,
		MetersEnabled:     []string{},
		TrialStartedAt:    trialState.TrialStartedAt,
		TrialEndsAt:       trialState.TrialEndsAt,
		RegisteredClaims: jwt.RegisteredClaims{
			IssuedAt:  jwt.NewNumericDate(now.UTC()),
			ExpiresAt: jwt.NewNumericDate(time.Unix(*trialState.TrialEndsAt, 0).UTC()),
			Subject:   strings.TrimSpace(ctx.requestID),
		},
	}
}

func tenantInstanceHost(baseURL, tenantID string) string {
	tenantID = strings.TrimSpace(tenantID)
	if tenantID == "" {
		return ""
	}
	baseDomain := strings.TrimSpace(baseDomainFromURL(baseURL))
	if baseDomain == "" {
		return ""
	}
	return strings.ToLower(fmt.Sprintf("%s.%s", tenantID, baseDomain))
}

func baseDomainFromURL(baseURL string) string {
	baseURL = strings.TrimSpace(baseURL)
	for _, prefix := range []string{"https://", "http://"} {
		if strings.HasPrefix(baseURL, prefix) {
			baseURL = strings.TrimPrefix(baseURL, prefix)
			break
		}
	}
	for i := 0; i < len(baseURL); i++ {
		if baseURL[i] == ':' || baseURL[i] == '/' {
			return baseURL[:i]
		}
	}
	return baseURL
}

// ProviderHosted reports whether this service bounds leases to the
// provider-operated ceiling. Exposed so the control plane wiring can be
// verified rather than assumed.
func (s *Service) ProviderHosted() bool {
	return s != nil && s.providerHosted
}