1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
// Copyright (c) 2015-2021 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Package licverifier implements a simple library to verify MinIO Subnet license keys.
package licverifier
import (
"context"
"crypto/ecdsa"
"crypto/x509"
"encoding/pem"
"errors"
"fmt"
"time"
"github.com/lestrrat-go/jwx/v2/jwa"
"github.com/lestrrat-go/jwx/v2/jwk"
"github.com/lestrrat-go/jwx/v2/jws"
"github.com/lestrrat-go/jwx/v2/jwt"
)
// LicenseVerifier needs an ECDSA public key in PEM format for initialization.
type LicenseVerifier struct {
keySet jwk.Set
}
// LicenseInfo holds customer metadata present in the license key.
type LicenseInfo struct {
LicenseToken string // License token
LicenseID string // Unique id of the license
Email string // Email of the license key requestor
Organization string // Subnet organization name
AccountID int64 // Subnet account id
DeploymentID string // Cluster deployment ID
StorageCapacity int64 // Storage capacity used in TB
Plan string // Subnet plan
IssuedAt time.Time // Time of license issue
ExpiresAt time.Time // Time of license expiry
APIKey string // Subnet account API Key
IsTrial bool // Is this a TRIAL license?
}
// license key JSON field names
const (
licenseID = "lid"
accountID = "aid"
deploymentID = "did"
organization = "org"
capacity = "cap"
issuedAt = "iat"
plan = "plan"
apiKey = "apiKey"
trial = "trial"
)
// parse PEM encoded PKCS1 or PKCS8 public key
func parseECPublicKeyFromPEM(key []byte) (*ecdsa.PublicKey, error) {
var err error
// Parse PEM block
var block *pem.Block
if block, _ = pem.Decode(key); block == nil {
return nil, errors.New("key must be a PEM encoded PKCS1 or PKCS8 key")
}
// Parse the key
var parsedKey interface{}
if parsedKey, err = x509.ParsePKIXPublicKey(block.Bytes); err != nil {
if cert, err := x509.ParseCertificate(block.Bytes); err == nil {
parsedKey = cert.PublicKey
} else {
return nil, err
}
}
var pkey *ecdsa.PublicKey
var ok bool
if pkey, ok = parsedKey.(*ecdsa.PublicKey); !ok {
return nil, errors.New("key is not a valid RSA public key")
}
return pkey, nil
}
// NewLicenseVerifier returns an initialized license verifier with the given
// ECDSA public key in PEM format.
func NewLicenseVerifier(pemBytes []byte) (*LicenseVerifier, error) {
pbKey, err := parseECPublicKeyFromPEM(pemBytes)
if err != nil {
return nil, fmt.Errorf("failed to parse public key: %w", err)
}
key, err := jwk.FromRaw(pbKey)
if err != nil {
return nil, err
}
key.Set(jwk.AlgorithmKey, jwa.ES384)
keyset := jwk.NewSet()
keyset.AddKey(key)
return &LicenseVerifier{
keySet: keyset,
}, nil
}
// toLicenseInfo extracts LicenseInfo from claims. It returns an error if any of
// the claim values are invalid.
func toLicenseInfo(license string, token jwt.Token) (LicenseInfo, error) {
claims, err := token.AsMap(context.Background())
if err != nil {
return LicenseInfo{}, err
}
accID, ok := claims[accountID].(float64)
if !ok || ok && accID < 0 {
return LicenseInfo{}, errors.New("invalid accountId in claims")
}
// deployment id may not be present in older licenses.
// so don't fail if it's not found.
depUUID, _ := claims[deploymentID].(string)
// license id may not be present in older licenses.
// so don't fail if it's not found.
licID, _ := claims[licenseID].(string)
orgName, ok := claims[organization].(string)
if !ok {
return LicenseInfo{}, errors.New("invalid organization in claims")
}
storageCap, ok := claims[capacity].(float64)
if !ok {
return LicenseInfo{}, errors.New("invalid storage capacity in claims")
}
plan, ok := claims[plan].(string)
if !ok {
return LicenseInfo{}, errors.New("invalid plan in claims")
}
iAt, ok := claims[issuedAt].(time.Time)
if !ok {
return LicenseInfo{}, errors.New("invalid issuedAt in claims")
}
// apiKey is optional as it's not present in older licenses
apiKey, _ := claims[apiKey].(string)
// isTrial is optional as it's not present in older licenses
// default value = false
isTrial, _ := claims[trial].(bool)
return LicenseInfo{
LicenseToken: license,
LicenseID: licID,
Email: token.Subject(),
Organization: orgName,
AccountID: int64(accID),
DeploymentID: depUUID,
StorageCapacity: int64(storageCap),
Plan: plan,
IssuedAt: iAt,
ExpiresAt: token.Expiration(),
APIKey: apiKey,
IsTrial: isTrial,
}, nil
}
// Verify verifies the license key and validates the claims present in it.
func (lv *LicenseVerifier) Verify(license string, options ...jwt.ParseOption) (LicenseInfo, error) {
options = append(options, jwt.WithKeySet(lv.keySet, jws.WithUseDefault(true)), jwt.WithValidate(true))
token, err := jwt.ParseString(license, options...)
if err != nil {
return LicenseInfo{}, fmt.Errorf("failed to verify license: %s", err)
}
return toLicenseInfo(license, token)
}
|