Use Case 024: License Key Management

Overview

Description

This use case describes how administrators import, view, validate, and revoke Riptide Platform license keys through the Application Manager web interface. License tokens are generated externally using the SDK LicenseGenerator tool and imported as opaque signed strings. Application Manager decodes the token metadata, stores it for future reference, and can optionally activate the license so connected applications begin using it.

Actors

Preconditions

1. Application Manager is running and accessible
2. Administrator is authenticated with the "Admin" policy
3. A valid license token has been generated externally via LicenseGenerator
4. (For validation) Riptide:Platform:License:PublicKey is configured in appsettings.json

Postconditions

Success Postconditions

1. License key record persisted in ConfigurationDbContext.LicenseKeys
2. Decoded metadata (IssuedTo, InstallationId, apps, features) stored for display
3. If activated, /platform/license.json updated in configuration file tree
4. If activated, previously active license deactivated
5. Activity logged in audit trail

Failure Postconditions

1. No record created if token format is invalid or duplicate
2. Error message displayed to administrator
3. No configuration changes if activation is not selected or fails

UC-024A: Import License Key

Triggers

• Administrator navigates to /license-keys/import
• Administrator pastes a license token and submits the form

Basic Flow

1. Administrator navigates to License Keys > Import License
2. System displays the import form with a textarea for the token, optional notes, and an "Activate this license now" checkbox (checked by default)
3. Administrator pastes the full RIPTIDE-PLATFORM-v2-{base64}:{base64} token
4. Administrator optionally adds notes (e.g., customer name, PO number)
5. Administrator chooses whether to activate immediately
6. System validates token format (prefix, separator, base64 structure)
7. System checks for duplicate tokens (rejects if already imported)
8. System decodes the base64 payload to extract: InstallationId, IssuedTo, IssuedAt, ExpiresAt, Applications/Features
9. System creates a LicenseKey entity with decoded metadata and Status = Active
10. If the token is already past its ExpiresAt, Status is set to Expired instead
11. If "Activate now" is checked and the license is not expired:
    • System clears IsActiveLicense on any previously active license
    • System writes the token and InstallationId to /platform/license.json in the configuration file tree
12. System redirects to the license detail page with a success message

Alternative Flows

• A1: Invalid token format — FluentValidation rejects the token; form redisplays with error
• A2: Duplicate token — Handler throws InvalidOperationException; error displayed to admin
• A3: Decode failure — Malformed base64 or JSON; error message shown
• A4: Expired on import — License stored with Status = Expired; not activated regardless of checkbox

UC-024B: View License Key List

Triggers

• Administrator navigates to /license-keys

Basic Flow

1. Administrator clicks Licenses in the navigation bar
2. System queries all license keys ordered by import date (newest first)
3. System auto-updates any Active licenses past their ExpiresAt to Expired status
4. System displays a table with: Issued To, Installation ID, Expires, Status badge, Application count, Imported date, and action dropdown
5. Active licenses show a "Active License" badge next to IssuedTo
6. Action dropdown offers: View Details, Revoke (for active licenses only)

UC-024C: View License Key Details

Triggers

• Administrator clicks "View Details" from the list or navigates to /license-keys/{id}

Basic Flow

1. System fetches the license key by ID with full decoded metadata
2. System displays:
   • License Information card: IssuedTo, InstallationId, masked token, IssuedAt, ExpiresAt, Status
   • Licensed Applications & Features card: tree showing each application with enabled/disabled status and nested features
   • Import Details sidebar: ImportedAt, ImportedBy, RevokedAt/By (if applicable)
   • Notes (if any)
3. Header shows "Active License" badge if this is the active license
4. Validate and Revoke buttons in the page header

UC-024D: Validate License Key

Triggers

• Administrator clicks Validate on the license detail page

Basic Flow

1. Administrator clicks the Validate button
2. System fetches the license token from the database
3. System decodes the token payload
4. System checks Riptide:Platform:License:PublicKey configuration
5. If public key is configured: system verifies the RSA-SHA256 signature
6. System checks whether the license has expired
7. System displays results in an alert: Valid/Invalid, signature verified/not, days remaining, error details

Alternative Flows

• A1: Public key not configured — Validation reports "signature not verified" but does not fail; expiry check still runs
• A2: Signature invalid — Validation reports "license may have been tampered with"
• A3: License expired — Validation reports "license has expired" with expiry date

UC-024E: Revoke License Key

Triggers

• Administrator clicks Revoke on the list or detail page

Basic Flow

1. System prompts for confirmation ("Are you sure? This cannot be undone.")
2. Administrator confirms
3. System sets Status = Revoked, RevokedAt = now, RevokedBy = current admin
4. If this was the active license, IsActiveLicense is cleared (no license is now active)
5. System displays success message and refreshes the page

Alternative Flows

• A1: Already revoked — Operation is idempotent; no error
• A2: License not found — Error message displayed

Business Rules

Data Requirements