mirror of https://github.com/docker/cli.git
auth: add support for oauth device-code login
This commit adds support for the oauth [device-code](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow) login flow when authenticating against the official registry. This is achieved by adding `cli/internal/oauth`, which contains code to manage interacting with the Docker OAuth tenant (`login.docker.com`), including launching the device-code flow, refreshing access using the refresh-token, and logging out. The `OAuthManager` introduced here is also made available through the `command.Cli` interface method `OAuthManager()`. In order to maintain compatibility with any clients manually accessing the credentials through `~/.docker/config.json` or via credential helpers, the added `OAuthManager` uses the retrieved access token to automatically generate a PAT with Hub, and store that in the credentials. Signed-off-by: Laura Brehm <laurabrehm@hey.com>
This commit is contained in:
parent
211a5403b3
commit
fcfdd7b91f
|
@ -10,6 +10,7 @@ import (
|
||||||
"github.com/docker/cli/cli/command"
|
"github.com/docker/cli/cli/command"
|
||||||
"github.com/docker/cli/cli/command/completion"
|
"github.com/docker/cli/cli/command/completion"
|
||||||
configtypes "github.com/docker/cli/cli/config/types"
|
configtypes "github.com/docker/cli/cli/config/types"
|
||||||
|
"github.com/docker/cli/cli/internal/oauth/manager"
|
||||||
registrytypes "github.com/docker/docker/api/types/registry"
|
registrytypes "github.com/docker/docker/api/types/registry"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
"github.com/docker/docker/errdefs"
|
"github.com/docker/docker/errdefs"
|
||||||
|
@ -100,10 +101,20 @@ func runLogin(ctx context.Context, dockerCli command.Cli, opts loginOptions) err
|
||||||
response, err = loginWithCredStoreCreds(ctx, dockerCli, &authConfig)
|
response, err = loginWithCredStoreCreds(ctx, dockerCli, &authConfig)
|
||||||
}
|
}
|
||||||
if err != nil || authConfig.Username == "" || authConfig.Password == "" {
|
if err != nil || authConfig.Username == "" || authConfig.Password == "" {
|
||||||
|
if isDefaultRegistry && opts.user == "" && opts.password == "" {
|
||||||
|
// todo(laurazard: clean this up
|
||||||
|
store := dockerCli.ConfigFile().GetCredentialsStore(serverAddress)
|
||||||
|
oauthAuthConfig, err := manager.NewManager(store).LoginDevice(ctx, dockerCli.Err())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
authConfig = registrytypes.AuthConfig(*oauthAuthConfig)
|
||||||
|
} else {
|
||||||
err = command.ConfigureAuth(ctx, dockerCli, opts.user, opts.password, &authConfig, isDefaultRegistry)
|
err = command.ConfigureAuth(ctx, dockerCli, opts.user, opts.password, &authConfig, isDefaultRegistry)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
response, err = clnt.RegistryLogin(ctx, authConfig)
|
response, err = clnt.RegistryLogin(ctx, authConfig)
|
||||||
if err != nil && client.IsErrConnectionFailed(err) {
|
if err != nil && client.IsErrConnectionFailed(err) {
|
||||||
|
|
|
@ -213,7 +213,9 @@ func TestLoginTermination(t *testing.T) {
|
||||||
|
|
||||||
runErr := make(chan error)
|
runErr := make(chan error)
|
||||||
go func() {
|
go func() {
|
||||||
runErr <- runLogin(ctx, cli, loginOptions{})
|
runErr <- runLogin(ctx, cli, loginOptions{
|
||||||
|
user: "test-user",
|
||||||
|
})
|
||||||
}()
|
}()
|
||||||
|
|
||||||
// Let the prompt get canceled by the context
|
// Let the prompt get canceled by the context
|
||||||
|
|
|
@ -7,6 +7,7 @@ import (
|
||||||
"github.com/docker/cli/cli"
|
"github.com/docker/cli/cli"
|
||||||
"github.com/docker/cli/cli/command"
|
"github.com/docker/cli/cli/command"
|
||||||
"github.com/docker/cli/cli/config/credentials"
|
"github.com/docker/cli/cli/config/credentials"
|
||||||
|
"github.com/docker/cli/cli/internal/oauth/manager"
|
||||||
"github.com/docker/docker/registry"
|
"github.com/docker/docker/registry"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
)
|
)
|
||||||
|
@ -34,7 +35,7 @@ func NewLogoutCommand(dockerCli command.Cli) *cobra.Command {
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
func runLogout(_ context.Context, dockerCli command.Cli, serverAddress string) error {
|
func runLogout(ctx context.Context, dockerCli command.Cli, serverAddress string) error {
|
||||||
var isDefaultRegistry bool
|
var isDefaultRegistry bool
|
||||||
|
|
||||||
if serverAddress == "" {
|
if serverAddress == "" {
|
||||||
|
@ -53,6 +54,13 @@ func runLogout(_ context.Context, dockerCli command.Cli, serverAddress string) e
|
||||||
regsToLogout = append(regsToLogout, hostnameAddress, "http://"+hostnameAddress, "https://"+hostnameAddress)
|
regsToLogout = append(regsToLogout, hostnameAddress, "http://"+hostnameAddress, "https://"+hostnameAddress)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if isDefaultRegistry {
|
||||||
|
store := dockerCli.ConfigFile().GetCredentialsStore(registry.IndexServer)
|
||||||
|
if err := manager.NewManager(store).Logout(ctx); err != nil {
|
||||||
|
fmt.Fprintf(dockerCli.Err(), "WARNING: %v\n", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
fmt.Fprintf(dockerCli.Out(), "Removing login credentials for %s\n", hostnameAddress)
|
fmt.Fprintf(dockerCli.Out(), "Removing login credentials for %s\n", hostnameAddress)
|
||||||
errs := make(map[string]error)
|
errs := make(map[string]error)
|
||||||
for _, r := range regsToLogout {
|
for _, r := range regsToLogout {
|
||||||
|
|
|
@ -0,0 +1,228 @@
|
||||||
|
// FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
|
||||||
|
//go:build go1.21
|
||||||
|
|
||||||
|
package api
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/docker/cli/cli/version"
|
||||||
|
)
|
||||||
|
|
||||||
|
type OAuthAPI interface {
|
||||||
|
GetDeviceCode(ctx context.Context, audience string) (State, error)
|
||||||
|
WaitForDeviceToken(ctx context.Context, state State) (TokenResponse, error)
|
||||||
|
RevokeToken(ctx context.Context, refreshToken string) error
|
||||||
|
GetAutoPAT(ctx context.Context, audience string, res TokenResponse) (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// API represents API interactions with Auth0.
|
||||||
|
type API struct {
|
||||||
|
// TenantURL is the base used for each request to Auth0.
|
||||||
|
TenantURL string
|
||||||
|
// ClientID is the client ID for the application to auth with the tenant.
|
||||||
|
ClientID string
|
||||||
|
// Scopes are the scopes that are requested during the device auth flow.
|
||||||
|
Scopes []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// TokenResponse represents the response of the /oauth/token route.
|
||||||
|
type TokenResponse struct {
|
||||||
|
AccessToken string `json:"access_token"`
|
||||||
|
IDToken string `json:"id_token"`
|
||||||
|
RefreshToken string `json:"refresh_token"`
|
||||||
|
Scope string `json:"scope"`
|
||||||
|
ExpiresIn int `json:"expires_in"`
|
||||||
|
TokenType string `json:"token_type"`
|
||||||
|
Error *string `json:"error,omitempty"`
|
||||||
|
ErrorDescription string `json:"error_description,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var ErrTimeout = errors.New("timed out waiting for device token")
|
||||||
|
|
||||||
|
// GetDeviceCode initiates the device-code auth flow with the tenant.
|
||||||
|
// The state returned contains the device code that the user must use to
|
||||||
|
// authenticate, as well as the URL to visit, etc.
|
||||||
|
func (a API) GetDeviceCode(ctx context.Context, audience string) (State, error) {
|
||||||
|
data := url.Values{
|
||||||
|
"client_id": {a.ClientID},
|
||||||
|
"audience": {audience},
|
||||||
|
"scope": {strings.Join(a.Scopes, " ")},
|
||||||
|
}
|
||||||
|
|
||||||
|
deviceCodeURL := a.TenantURL + "/oauth/device/code"
|
||||||
|
resp, err := postForm(ctx, deviceCodeURL, strings.NewReader(data.Encode()))
|
||||||
|
if err != nil {
|
||||||
|
return State{}, err
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
return State{}, tryDecodeOAuthError(resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
var state State
|
||||||
|
err = json.NewDecoder(resp.Body).Decode(&state)
|
||||||
|
if err != nil {
|
||||||
|
return state, fmt.Errorf("failed to get device code: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return state, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func tryDecodeOAuthError(resp *http.Response) error {
|
||||||
|
var body map[string]any
|
||||||
|
if err := json.NewDecoder(resp.Body).Decode(&body); err == nil {
|
||||||
|
if errorDescription, ok := body["error_description"].(string); ok {
|
||||||
|
return errors.New(errorDescription)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return errors.New("unexpected response from tenant: " + resp.Status)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WaitForDeviceToken polls the tenant to get access/refresh tokens for the user.
|
||||||
|
// This should be called after GetDeviceCode, and will block until the user has
|
||||||
|
// authenticated or we have reached the time limit for authenticating (based on
|
||||||
|
// the response from GetDeviceCode).
|
||||||
|
func (a API) WaitForDeviceToken(ctx context.Context, state State) (TokenResponse, error) {
|
||||||
|
ticker := time.NewTicker(state.IntervalDuration())
|
||||||
|
defer ticker.Stop()
|
||||||
|
timeout := time.After(state.ExpiryDuration())
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return TokenResponse{}, ctx.Err()
|
||||||
|
case <-ticker.C:
|
||||||
|
res, err := a.getDeviceToken(ctx, state)
|
||||||
|
if err != nil {
|
||||||
|
return res, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Error != nil {
|
||||||
|
if *res.Error == "authorization_pending" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, errors.New(res.ErrorDescription)
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
case <-timeout:
|
||||||
|
return TokenResponse{}, ErrTimeout
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// getToken calls the token endpoint of Auth0 and returns the response.
|
||||||
|
func (a API) getDeviceToken(ctx context.Context, state State) (TokenResponse, error) {
|
||||||
|
data := url.Values{
|
||||||
|
"client_id": {a.ClientID},
|
||||||
|
"grant_type": {"urn:ietf:params:oauth:grant-type:device_code"},
|
||||||
|
"device_code": {state.DeviceCode},
|
||||||
|
}
|
||||||
|
oauthTokenURL := a.TenantURL + "/oauth/token"
|
||||||
|
|
||||||
|
resp, err := postForm(ctx, oauthTokenURL, strings.NewReader(data.Encode()))
|
||||||
|
if err != nil {
|
||||||
|
return TokenResponse{}, fmt.Errorf("failed to get tokens: %w", err)
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
// this endpoint returns a 403 with an `authorization_pending` error until the
|
||||||
|
// user has authenticated, so we don't check the status code here and instead
|
||||||
|
// decode the response and check for the error.
|
||||||
|
var res TokenResponse
|
||||||
|
err = json.NewDecoder(resp.Body).Decode(&res)
|
||||||
|
if err != nil {
|
||||||
|
return res, fmt.Errorf("failed to decode response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RevokeToken revokes a refresh token with the tenant so that it can no longer
|
||||||
|
// be used to get new tokens.
|
||||||
|
func (a API) RevokeToken(ctx context.Context, refreshToken string) error {
|
||||||
|
data := url.Values{
|
||||||
|
"client_id": {a.ClientID},
|
||||||
|
"token": {refreshToken},
|
||||||
|
}
|
||||||
|
|
||||||
|
revokeURL := a.TenantURL + "/oauth/revoke"
|
||||||
|
resp, err := postForm(ctx, revokeURL, strings.NewReader(data.Encode()))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
return tryDecodeOAuthError(resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func postForm(ctx context.Context, reqURL string, data io.Reader) (*http.Response, error) {
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, reqURL, data)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
|
||||||
|
cliVersion := strings.ReplaceAll(version.Version, ".", "_")
|
||||||
|
req.Header.Set("User-Agent", fmt.Sprintf("docker-cli:%s:%s-%s", cliVersion, runtime.GOOS, runtime.GOARCH))
|
||||||
|
|
||||||
|
return http.DefaultClient.Do(req)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a API) GetAutoPAT(ctx context.Context, audience string, res TokenResponse) (string, error) {
|
||||||
|
patURL := audience + "/v2/access-tokens/desktop-generate"
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, patURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("Authorization", "Bearer "+res.AccessToken)
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
resp, err := http.DefaultClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
if resp.StatusCode != http.StatusCreated {
|
||||||
|
return "", fmt.Errorf("unexpected response from Hub: %s", resp.Status)
|
||||||
|
}
|
||||||
|
|
||||||
|
var response patGenerateResponse
|
||||||
|
err = json.NewDecoder(resp.Body).Decode(&response)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return response.Data.Token, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type patGenerateResponse struct {
|
||||||
|
Data struct {
|
||||||
|
Token string `json:"token"`
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,428 @@
|
||||||
|
package api
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gotest.tools/v3/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGetDeviceCode(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
t.Run("success", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
var clientID, audience, scope, path string
|
||||||
|
expectedState := State{
|
||||||
|
DeviceCode: "aDeviceCode",
|
||||||
|
UserCode: "aUserCode",
|
||||||
|
VerificationURI: "aVerificationURI",
|
||||||
|
ExpiresIn: 60,
|
||||||
|
}
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
r.ParseForm()
|
||||||
|
clientID = r.FormValue("client_id")
|
||||||
|
audience = r.FormValue("audience")
|
||||||
|
scope = r.FormValue("scope")
|
||||||
|
path = r.URL.Path
|
||||||
|
|
||||||
|
jsonState, err := json.Marshal(expectedState)
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
_, _ = w.Write(jsonState)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
state, err := api.GetDeviceCode(context.Background(), "anAudience")
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.DeepEqual(t, expectedState, state)
|
||||||
|
assert.Equal(t, clientID, "aClientID")
|
||||||
|
assert.Equal(t, audience, "anAudience")
|
||||||
|
assert.Equal(t, scope, "bork meow")
|
||||||
|
assert.Equal(t, path, "/oauth/device/code")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("error w/ description", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
jsonState, err := json.Marshal(TokenResponse{
|
||||||
|
ErrorDescription: "invalid audience",
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
_, _ = w.Write(jsonState)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := api.GetDeviceCode(context.Background(), "bad_audience")
|
||||||
|
|
||||||
|
assert.ErrorContains(t, err, "invalid audience")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("general error", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
http.Error(w, "an error", http.StatusInternalServerError)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := api.GetDeviceCode(context.Background(), "anAudience")
|
||||||
|
|
||||||
|
assert.ErrorContains(t, err, "unexpected response from tenant: 500 Internal Server Error")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("canceled context", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
time.Sleep(2 * time.Second)
|
||||||
|
http.Error(w, "an error", http.StatusInternalServerError)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
go func() {
|
||||||
|
time.Sleep(1 * time.Second)
|
||||||
|
cancel()
|
||||||
|
}()
|
||||||
|
_, err := api.GetDeviceCode(ctx, "anAudience")
|
||||||
|
|
||||||
|
assert.ErrorContains(t, err, "context canceled")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWaitForDeviceToken(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
t.Run("success", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
expectedToken := TokenResponse{
|
||||||
|
AccessToken: "a-real-token",
|
||||||
|
IDToken: "",
|
||||||
|
RefreshToken: "the-refresh-token",
|
||||||
|
Scope: "",
|
||||||
|
ExpiresIn: 3600,
|
||||||
|
TokenType: "",
|
||||||
|
}
|
||||||
|
var respond atomic.Bool
|
||||||
|
go func() {
|
||||||
|
time.Sleep(5 * time.Second)
|
||||||
|
respond.Store(true)
|
||||||
|
}()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
assert.Equal(t, "POST", r.Method)
|
||||||
|
assert.Equal(t, "/oauth/token", r.URL.Path)
|
||||||
|
assert.Equal(t, r.FormValue("client_id"), "aClientID")
|
||||||
|
assert.Equal(t, r.FormValue("grant_type"), "urn:ietf:params:oauth:grant-type:device_code")
|
||||||
|
assert.Equal(t, r.FormValue("device_code"), "aDeviceCode")
|
||||||
|
|
||||||
|
if respond.Load() {
|
||||||
|
jsonState, err := json.Marshal(expectedToken)
|
||||||
|
assert.NilError(t, err)
|
||||||
|
w.Write(jsonState)
|
||||||
|
} else {
|
||||||
|
pendingError := "authorization_pending"
|
||||||
|
jsonResponse, err := json.Marshal(TokenResponse{
|
||||||
|
Error: &pendingError,
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
w.Write(jsonResponse)
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
state := State{
|
||||||
|
DeviceCode: "aDeviceCode",
|
||||||
|
UserCode: "aUserCode",
|
||||||
|
Interval: 1,
|
||||||
|
ExpiresIn: 30,
|
||||||
|
}
|
||||||
|
token, err := api.WaitForDeviceToken(context.Background(), state)
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.DeepEqual(t, token, expectedToken)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("timeout", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
assert.Equal(t, "POST", r.Method)
|
||||||
|
assert.Equal(t, "/oauth/token", r.URL.Path)
|
||||||
|
assert.Equal(t, r.FormValue("client_id"), "aClientID")
|
||||||
|
assert.Equal(t, r.FormValue("grant_type"), "urn:ietf:params:oauth:grant-type:device_code")
|
||||||
|
assert.Equal(t, r.FormValue("device_code"), "aDeviceCode")
|
||||||
|
|
||||||
|
pendingError := "authorization_pending"
|
||||||
|
jsonResponse, err := json.Marshal(TokenResponse{
|
||||||
|
Error: &pendingError,
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
w.Write(jsonResponse)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
state := State{
|
||||||
|
DeviceCode: "aDeviceCode",
|
||||||
|
UserCode: "aUserCode",
|
||||||
|
Interval: 1,
|
||||||
|
ExpiresIn: 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := api.WaitForDeviceToken(context.Background(), state)
|
||||||
|
|
||||||
|
assert.ErrorIs(t, err, ErrTimeout)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("canceled context", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
pendingError := "authorization_pending"
|
||||||
|
jsonResponse, err := json.Marshal(TokenResponse{
|
||||||
|
Error: &pendingError,
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
w.Write(jsonResponse)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
state := State{
|
||||||
|
DeviceCode: "aDeviceCode",
|
||||||
|
UserCode: "aUserCode",
|
||||||
|
Interval: 1,
|
||||||
|
ExpiresIn: 5,
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
go func() {
|
||||||
|
time.Sleep(1 * time.Second)
|
||||||
|
cancel()
|
||||||
|
}()
|
||||||
|
_, err := api.WaitForDeviceToken(ctx, state)
|
||||||
|
|
||||||
|
assert.ErrorContains(t, err, "context canceled")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRevoke(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
t.Run("success", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
assert.Equal(t, "POST", r.Method)
|
||||||
|
assert.Equal(t, "/oauth/revoke", r.URL.Path)
|
||||||
|
assert.Equal(t, r.FormValue("client_id"), "aClientID")
|
||||||
|
assert.Equal(t, r.FormValue("token"), "v1.a-refresh-token")
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
err := api.RevokeToken(context.Background(), "v1.a-refresh-token")
|
||||||
|
assert.NilError(t, err)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("unexpected response", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
assert.Equal(t, "POST", r.Method)
|
||||||
|
assert.Equal(t, "/oauth/revoke", r.URL.Path)
|
||||||
|
assert.Equal(t, r.FormValue("client_id"), "aClientID")
|
||||||
|
assert.Equal(t, r.FormValue("token"), "v1.a-refresh-token")
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusNotFound)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
err := api.RevokeToken(context.Background(), "v1.a-refresh-token")
|
||||||
|
assert.ErrorContains(t, err, "unexpected response from tenant: 404 Not Found")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("error w/ description", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
jsonState, err := json.Marshal(TokenResponse{
|
||||||
|
ErrorDescription: "invalid client id",
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
_, _ = w.Write(jsonState)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
err := api.RevokeToken(context.Background(), "v1.a-refresh-token")
|
||||||
|
assert.ErrorContains(t, err, "invalid client id")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("canceled context", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
assert.Equal(t, "POST", r.Method)
|
||||||
|
assert.Equal(t, "/oauth/revoke", r.URL.Path)
|
||||||
|
assert.Equal(t, r.FormValue("client_id"), "aClientID")
|
||||||
|
assert.Equal(t, r.FormValue("token"), "v1.a-refresh-token")
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
err := api.RevokeToken(ctx, "v1.a-refresh-token")
|
||||||
|
|
||||||
|
assert.ErrorContains(t, err, "context canceled")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetAutoPAT(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
t.Run("success", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
assert.Equal(t, "POST", r.Method)
|
||||||
|
assert.Equal(t, "/v2/access-tokens/desktop-generate", r.URL.Path)
|
||||||
|
assert.Equal(t, "Bearer bork", r.Header.Get("Authorization"))
|
||||||
|
assert.Equal(t, "application/json", r.Header.Get("Content-Type"))
|
||||||
|
|
||||||
|
marshalledResponse, err := json.Marshal(patGenerateResponse{
|
||||||
|
Data: struct {
|
||||||
|
Token string `json:"token"`
|
||||||
|
}{
|
||||||
|
Token: "a-docker-pat",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
w.WriteHeader(http.StatusCreated)
|
||||||
|
w.Write(marshalledResponse)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
pat, err := api.GetAutoPAT(context.Background(), ts.URL, TokenResponse{
|
||||||
|
AccessToken: "bork",
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.Equal(t, "a-docker-pat", pat)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("general error", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusInternalServerError)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := api.GetAutoPAT(context.Background(), ts.URL, TokenResponse{
|
||||||
|
AccessToken: "bork",
|
||||||
|
})
|
||||||
|
assert.ErrorContains(t, err, "unexpected response from Hub: 500 Internal Server Error")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("context canceled", func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
assert.Equal(t, "POST", r.Method)
|
||||||
|
assert.Equal(t, "/v2/access-tokens/desktop-generate", r.URL.Path)
|
||||||
|
assert.Equal(t, "Bearer bork", r.Header.Get("Authorization"))
|
||||||
|
assert.Equal(t, "application/json", r.Header.Get("Content-Type"))
|
||||||
|
|
||||||
|
marshalledResponse, err := json.Marshal(patGenerateResponse{
|
||||||
|
Data: struct {
|
||||||
|
Token string `json:"token"`
|
||||||
|
}{
|
||||||
|
Token: "a-docker-pat",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
time.Sleep(500 * time.Millisecond)
|
||||||
|
w.WriteHeader(http.StatusCreated)
|
||||||
|
w.Write(marshalledResponse)
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
api := API{
|
||||||
|
TenantURL: ts.URL,
|
||||||
|
ClientID: "aClientID",
|
||||||
|
Scopes: []string{"bork", "meow"},
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
pat, err := api.GetAutoPAT(ctx, ts.URL, TokenResponse{
|
||||||
|
AccessToken: "bork",
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.ErrorContains(t, err, "context canceled")
|
||||||
|
assert.Equal(t, "", pat)
|
||||||
|
})
|
||||||
|
}
|
|
@ -0,0 +1,26 @@
|
||||||
|
package api
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// State represents the state of exchange after submitting.
|
||||||
|
type State struct {
|
||||||
|
DeviceCode string `json:"device_code"`
|
||||||
|
UserCode string `json:"user_code"`
|
||||||
|
VerificationURI string `json:"verification_uri_complete"`
|
||||||
|
ExpiresIn int `json:"expires_in"`
|
||||||
|
Interval int `json:"interval"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntervalDuration returns the duration that should be waited between each auth
|
||||||
|
// polling event.
|
||||||
|
func (s State) IntervalDuration() time.Duration {
|
||||||
|
return time.Second * time.Duration(s.Interval)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExpiryDuration returns the total duration for which the client should keep
|
||||||
|
// polling.
|
||||||
|
func (s State) ExpiryDuration() time.Duration {
|
||||||
|
return time.Second * time.Duration(s.ExpiresIn)
|
||||||
|
}
|
|
@ -0,0 +1,73 @@
|
||||||
|
package oauth
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/go-jose/go-jose/v3/jwt"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Claims represents standard claims along with some custom ones.
|
||||||
|
type Claims struct {
|
||||||
|
jwt.Claims
|
||||||
|
|
||||||
|
// Domain is the domain claims for the token.
|
||||||
|
Domain DomainClaims `json:"https://hub.docker.com"`
|
||||||
|
|
||||||
|
// Scope is the scopes for the claims as a string that is space delimited.
|
||||||
|
Scope string `json:"scope,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DomainClaims represents a custom claim data set that doesn't change the spec
|
||||||
|
// payload. This is primarily introduced by Auth0 and is defined by a fully
|
||||||
|
// specified URL as it's key. e.g. "https://hub.docker.com"
|
||||||
|
type DomainClaims struct {
|
||||||
|
// UUID is the user, machine client, or organization's UUID in our database.
|
||||||
|
UUID string `json:"uuid"`
|
||||||
|
|
||||||
|
// Email is the user's email address.
|
||||||
|
Email string `json:"email"`
|
||||||
|
|
||||||
|
// Username is the user's username.
|
||||||
|
Username string `json:"username"`
|
||||||
|
|
||||||
|
// Source is the source of the JWT. This should look like
|
||||||
|
// `docker_{type}|{id}`.
|
||||||
|
Source string `json:"source"`
|
||||||
|
|
||||||
|
// SessionID is the unique ID of the token.
|
||||||
|
SessionID string `json:"session_id"`
|
||||||
|
|
||||||
|
// ClientID is the client_id that generated the token. This is filled if
|
||||||
|
// M2M.
|
||||||
|
ClientID string `json:"client_id,omitempty"`
|
||||||
|
|
||||||
|
// ClientName is the name of the client that generated the token. This is
|
||||||
|
// filled if M2M.
|
||||||
|
ClientName string `json:"client_name,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Source represents a source of a JWT.
|
||||||
|
type Source struct {
|
||||||
|
// Type is the type of source. This could be "pat" etc.
|
||||||
|
Type string `json:"type"`
|
||||||
|
|
||||||
|
// ID is the identifier to the source type. If "pat" then this will be the
|
||||||
|
// ID of the PAT.
|
||||||
|
ID string `json:"id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetClaims returns claims from an access token without verification.
|
||||||
|
func GetClaims(accessToken string) (claims Claims, err error) {
|
||||||
|
token, err := parseSigned(accessToken)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
err = token.UnsafeClaimsWithoutVerification(&claims)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseSigned parses a JWT and returns the signature object or error. This does
|
||||||
|
// not verify the validity of the JWT.
|
||||||
|
func parseSigned(token string) (*jwt.JSONWebToken, error) {
|
||||||
|
return jwt.ParseSigned(token)
|
||||||
|
}
|
|
@ -0,0 +1,199 @@
|
||||||
|
package manager
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/docker/cli/cli/config/credentials"
|
||||||
|
"github.com/docker/cli/cli/config/types"
|
||||||
|
"github.com/docker/cli/cli/internal/oauth"
|
||||||
|
"github.com/docker/cli/cli/internal/oauth/api"
|
||||||
|
"github.com/docker/docker/registry"
|
||||||
|
"github.com/morikuni/aec"
|
||||||
|
|
||||||
|
"github.com/pkg/browser"
|
||||||
|
)
|
||||||
|
|
||||||
|
// OAuthManager is the manager responsible for handling authentication
|
||||||
|
// flows with the oauth tenant.
|
||||||
|
type OAuthManager struct {
|
||||||
|
store credentials.Store
|
||||||
|
tenant string
|
||||||
|
audience string
|
||||||
|
clientID string
|
||||||
|
api api.OAuthAPI
|
||||||
|
openBrowser func(string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// OAuthManagerOptions are the options used for New to create a new auth manager.
|
||||||
|
type OAuthManagerOptions struct {
|
||||||
|
Store credentials.Store
|
||||||
|
Audience string
|
||||||
|
ClientID string
|
||||||
|
Scopes []string
|
||||||
|
Tenant string
|
||||||
|
DeviceName string
|
||||||
|
OpenBrowser func(string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
func New(options OAuthManagerOptions) *OAuthManager {
|
||||||
|
scopes := []string{"openid", "offline_access"}
|
||||||
|
if len(options.Scopes) > 0 {
|
||||||
|
scopes = options.Scopes
|
||||||
|
}
|
||||||
|
|
||||||
|
openBrowser := options.OpenBrowser
|
||||||
|
if openBrowser == nil {
|
||||||
|
// Prevent errors from missing binaries (like xdg-open) from
|
||||||
|
// cluttering the output. We can handle errors ourselves.
|
||||||
|
browser.Stdout = io.Discard
|
||||||
|
browser.Stderr = io.Discard
|
||||||
|
openBrowser = browser.OpenURL
|
||||||
|
}
|
||||||
|
|
||||||
|
return &OAuthManager{
|
||||||
|
clientID: options.ClientID,
|
||||||
|
audience: options.Audience,
|
||||||
|
tenant: options.Tenant,
|
||||||
|
store: options.Store,
|
||||||
|
api: api.API{
|
||||||
|
TenantURL: "https://" + options.Tenant,
|
||||||
|
ClientID: options.ClientID,
|
||||||
|
Scopes: scopes,
|
||||||
|
},
|
||||||
|
openBrowser: openBrowser,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoginDevice launches the device authentication flow with the tenant,
|
||||||
|
// printing instructions to the provided writer and attempting to open the
|
||||||
|
// browser for the user to authenticate.
|
||||||
|
// After the user completes the browser login, LoginDevice uses the retrieved
|
||||||
|
// tokens to create a Hub PAT which is returned to the caller.
|
||||||
|
// The retrieved tokens are stored in the credentials store (under a separate
|
||||||
|
// key), and the refresh token is concatenated with the client ID.
|
||||||
|
func (m *OAuthManager) LoginDevice(ctx context.Context, w io.Writer) (*types.AuthConfig, error) {
|
||||||
|
state, err := m.api.GetDeviceCode(ctx, m.audience)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to get device code: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if state.UserCode == "" {
|
||||||
|
return nil, errors.New("no user code returned")
|
||||||
|
}
|
||||||
|
|
||||||
|
_, _ = fmt.Fprintln(w, aec.Bold.Apply("\nUSING WEB BASED LOGIN"))
|
||||||
|
_, _ = fmt.Fprintln(w, "To sign in with credentials on the command line, use 'docker login -u <username>'")
|
||||||
|
_, _ = fmt.Fprintf(w, "\nYour one-time device confirmation code is: "+aec.Bold.Apply("%s\n"), state.UserCode)
|
||||||
|
_, _ = fmt.Fprintf(w, aec.Bold.Apply("Press ENTER")+" to open your browser or submit your device code here: "+aec.Underline.Apply("%s\n"), strings.Split(state.VerificationURI, "?")[0])
|
||||||
|
|
||||||
|
tokenResChan := make(chan api.TokenResponse)
|
||||||
|
waitForTokenErrChan := make(chan error)
|
||||||
|
go func() {
|
||||||
|
tokenRes, err := m.api.WaitForDeviceToken(ctx, state)
|
||||||
|
if err != nil {
|
||||||
|
waitForTokenErrChan <- err
|
||||||
|
return
|
||||||
|
}
|
||||||
|
tokenResChan <- tokenRes
|
||||||
|
}()
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
reader := bufio.NewReader(os.Stdin)
|
||||||
|
_, _ = reader.ReadString('\n')
|
||||||
|
_ = m.openBrowser(state.VerificationURI)
|
||||||
|
}()
|
||||||
|
|
||||||
|
_, _ = fmt.Fprint(w, "\nWaiting for authentication in the browser…\n")
|
||||||
|
var tokenRes api.TokenResponse
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil, errors.New("login canceled")
|
||||||
|
case err := <-waitForTokenErrChan:
|
||||||
|
return nil, fmt.Errorf("failed waiting for authentication: %w", err)
|
||||||
|
case tokenRes = <-tokenResChan:
|
||||||
|
}
|
||||||
|
|
||||||
|
claims, err := oauth.GetClaims(tokenRes.AccessToken)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to parse token claims: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = m.storeTokensInStore(tokenRes, claims.Domain.Username)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to store tokens: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
pat, err := m.api.GetAutoPAT(ctx, m.audience, tokenRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &types.AuthConfig{
|
||||||
|
Username: claims.Domain.Username,
|
||||||
|
Password: pat,
|
||||||
|
ServerAddress: registry.IndexServer,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Logout fetches the refresh token from the store and revokes it
|
||||||
|
// with the configured oauth tenant. The stored access and refresh
|
||||||
|
// tokens are then erased from the store.
|
||||||
|
// If the refresh token is not found in the store, an error is not
|
||||||
|
// returned.
|
||||||
|
func (m *OAuthManager) Logout(ctx context.Context) error {
|
||||||
|
refreshConfig, err := m.store.Get(refreshTokenKey)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if refreshConfig.Password == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
parts := strings.Split(refreshConfig.Password, "..")
|
||||||
|
if len(parts) != 2 {
|
||||||
|
// the token wasn't stored by the CLI, so don't revoke it
|
||||||
|
// or erase it from the store/error
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// erase the token from the store first, that way
|
||||||
|
// if the revoke fails, the user can try to logout again
|
||||||
|
if err := m.eraseTokensFromStore(); err != nil {
|
||||||
|
return fmt.Errorf("failed to erase tokens: %w", err)
|
||||||
|
}
|
||||||
|
if err := m.api.RevokeToken(ctx, parts[0]); err != nil {
|
||||||
|
return fmt.Errorf("credentials erased successfully, but there was a failure to revoke the OAuth refresh token with the tenant: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
accessTokenKey = registry.IndexServer + "access-token"
|
||||||
|
refreshTokenKey = registry.IndexServer + "refresh-token"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (m *OAuthManager) storeTokensInStore(tokens api.TokenResponse, username string) error {
|
||||||
|
return errors.Join(
|
||||||
|
m.store.Store(types.AuthConfig{
|
||||||
|
Username: username,
|
||||||
|
Password: tokens.AccessToken,
|
||||||
|
ServerAddress: accessTokenKey,
|
||||||
|
}),
|
||||||
|
m.store.Store(types.AuthConfig{
|
||||||
|
Username: username,
|
||||||
|
Password: tokens.RefreshToken + ".." + m.clientID,
|
||||||
|
ServerAddress: refreshTokenKey,
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *OAuthManager) eraseTokensFromStore() error {
|
||||||
|
return errors.Join(
|
||||||
|
m.store.Erase(accessTokenKey),
|
||||||
|
m.store.Erase(refreshTokenKey),
|
||||||
|
)
|
||||||
|
}
|
|
@ -0,0 +1,363 @@
|
||||||
|
package manager
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/docker/cli/cli/config/credentials"
|
||||||
|
"github.com/docker/cli/cli/config/types"
|
||||||
|
"github.com/docker/cli/cli/internal/oauth/api"
|
||||||
|
"gotest.tools/v3/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
//nolint:lll
|
||||||
|
validToken = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhYa3BCdDNyV3MyRy11YjlscEpncSJ9.eyJodHRwczovL2h1Yi5kb2NrZXIuY29tIjp7ImVtYWlsIjoiYm9ya0Bkb2NrZXIuY29tIiwic2Vzc2lvbl9pZCI6ImEtc2Vzc2lvbi1pZCIsInNvdXJjZSI6InNhbWxwIiwidXNlcm5hbWUiOiJib3JrISIsInV1aWQiOiIwMTIzLTQ1Njc4OSJ9LCJpc3MiOiJodHRwczovL2xvZ2luLmRvY2tlci5jb20vIiwic3ViIjoic2FtbHB8c2FtbHAtZG9ja2VyfGJvcmtAZG9ja2VyLmNvbSIsImF1ZCI6WyJodHRwczovL2F1ZGllbmNlLmNvbSJdLCJpYXQiOjE3MTk1MDI5MzksImV4cCI6MTcxOTUwNjUzOSwic2NvcGUiOiJvcGVuaWQgb2ZmbGluZV9hY2Nlc3MifQ.VUSp-9_SOvMPWJPRrSh7p4kSPoye4DA3kyd2I0TW0QtxYSRq7xCzNj0NC_ywlPlKBFBeXKm4mh93d1vBSh79I9Heq5tj0Fr4KH77U5xJRMEpjHqoT5jxMEU1hYXX92xctnagBMXxDvzUfu3Yf0tvYSA0RRoGbGTHfdYYRwOrGbwQ75Qg1dyIxUkwsG053eYX2XkmLGxymEMgIq_gWksgAamOc40_0OCdGr-MmDeD2HyGUa309aGltzQUw7Z0zG1AKSXy3WwfMHdWNFioTAvQphwEyY3US8ybSJi78upSFTjwUcryMeHUwQ3uV9PxwPMyPoYxo1izVB-OUJxM8RqEbg"
|
||||||
|
)
|
||||||
|
|
||||||
|
// parsed token:
|
||||||
|
// {
|
||||||
|
// "https://hub.docker.com": {
|
||||||
|
// "email": "bork@docker.com",
|
||||||
|
// "session_id": "a-session-id",
|
||||||
|
// "source": "samlp",
|
||||||
|
// "username": "bork!",
|
||||||
|
// "uuid": "0123-456789"
|
||||||
|
// },
|
||||||
|
// "iss": "https://login.docker.com/",
|
||||||
|
// "sub": "samlp|samlp-docker|bork@docker.com",
|
||||||
|
// "aud": [
|
||||||
|
// "https://audience.com"
|
||||||
|
// ],
|
||||||
|
// "iat": 1719502939,
|
||||||
|
// "exp": 1719506539,
|
||||||
|
// "scope": "openid offline_access"
|
||||||
|
// }
|
||||||
|
|
||||||
|
func TestLoginDevice(t *testing.T) {
|
||||||
|
t.Run("valid token", func(t *testing.T) {
|
||||||
|
expectedState := api.State{
|
||||||
|
DeviceCode: "device-code",
|
||||||
|
UserCode: "0123-4567",
|
||||||
|
VerificationURI: "an-url",
|
||||||
|
ExpiresIn: 300,
|
||||||
|
}
|
||||||
|
var receivedAudience string
|
||||||
|
getDeviceToken := func(audience string) (api.State, error) {
|
||||||
|
receivedAudience = audience
|
||||||
|
return expectedState, nil
|
||||||
|
}
|
||||||
|
var receivedState api.State
|
||||||
|
waitForDeviceToken := func(state api.State) (api.TokenResponse, error) {
|
||||||
|
receivedState = state
|
||||||
|
return api.TokenResponse{
|
||||||
|
AccessToken: validToken,
|
||||||
|
RefreshToken: "refresh-token",
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
var receivedAccessToken, getPatReceivedAudience string
|
||||||
|
getAutoPat := func(audience string, res api.TokenResponse) (string, error) {
|
||||||
|
receivedAccessToken = res.AccessToken
|
||||||
|
getPatReceivedAudience = audience
|
||||||
|
return "a-pat", nil
|
||||||
|
}
|
||||||
|
api := &testAPI{
|
||||||
|
getDeviceToken: getDeviceToken,
|
||||||
|
waitForDeviceToken: waitForDeviceToken,
|
||||||
|
getAutoPAT: getAutoPat,
|
||||||
|
}
|
||||||
|
store := newStore(map[string]types.AuthConfig{})
|
||||||
|
manager := OAuthManager{
|
||||||
|
store: credentials.NewFileStore(store),
|
||||||
|
audience: "https://hub.docker.com",
|
||||||
|
api: api,
|
||||||
|
openBrowser: func(url string) error {
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
authConfig, err := manager.LoginDevice(context.Background(), os.Stderr)
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.Equal(t, receivedAudience, "https://hub.docker.com")
|
||||||
|
assert.Equal(t, receivedState, expectedState)
|
||||||
|
assert.DeepEqual(t, authConfig, &types.AuthConfig{
|
||||||
|
Username: "bork!",
|
||||||
|
Password: "a-pat",
|
||||||
|
ServerAddress: "https://index.docker.io/v1/",
|
||||||
|
})
|
||||||
|
assert.Equal(t, receivedAccessToken, validToken)
|
||||||
|
assert.Equal(t, getPatReceivedAudience, "https://hub.docker.com")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("stores in cred store", func(t *testing.T) {
|
||||||
|
getDeviceToken := func(audience string) (api.State, error) {
|
||||||
|
return api.State{
|
||||||
|
DeviceCode: "device-code",
|
||||||
|
UserCode: "0123-4567",
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
waitForDeviceToken := func(state api.State) (api.TokenResponse, error) {
|
||||||
|
return api.TokenResponse{
|
||||||
|
AccessToken: validToken,
|
||||||
|
RefreshToken: "refresh-token",
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
getAutoPAT := func(audience string, res api.TokenResponse) (string, error) {
|
||||||
|
return "a-pat", nil
|
||||||
|
}
|
||||||
|
a := &testAPI{
|
||||||
|
getDeviceToken: getDeviceToken,
|
||||||
|
waitForDeviceToken: waitForDeviceToken,
|
||||||
|
getAutoPAT: getAutoPAT,
|
||||||
|
}
|
||||||
|
store := newStore(map[string]types.AuthConfig{})
|
||||||
|
manager := OAuthManager{
|
||||||
|
clientID: "client-id",
|
||||||
|
store: credentials.NewFileStore(store),
|
||||||
|
api: a,
|
||||||
|
openBrowser: func(url string) error {
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
authConfig, err := manager.LoginDevice(context.Background(), os.Stderr)
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.Equal(t, authConfig.Password, "a-pat")
|
||||||
|
assert.Equal(t, authConfig.Username, "bork!")
|
||||||
|
|
||||||
|
assert.Equal(t, len(store.configs), 2)
|
||||||
|
assert.Equal(t, store.configs["https://index.docker.io/v1/access-token"].Password, validToken)
|
||||||
|
assert.Equal(t, store.configs["https://index.docker.io/v1/refresh-token"].Password, "refresh-token..client-id")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("timeout", func(t *testing.T) {
|
||||||
|
getDeviceToken := func(audience string) (api.State, error) {
|
||||||
|
return api.State{
|
||||||
|
DeviceCode: "device-code",
|
||||||
|
UserCode: "0123-4567",
|
||||||
|
VerificationURI: "an-url",
|
||||||
|
ExpiresIn: 300,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
waitForDeviceToken := func(state api.State) (api.TokenResponse, error) {
|
||||||
|
return api.TokenResponse{}, api.ErrTimeout
|
||||||
|
}
|
||||||
|
a := &testAPI{
|
||||||
|
getDeviceToken: getDeviceToken,
|
||||||
|
waitForDeviceToken: waitForDeviceToken,
|
||||||
|
}
|
||||||
|
manager := OAuthManager{
|
||||||
|
api: a,
|
||||||
|
openBrowser: func(url string) error {
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := manager.LoginDevice(context.Background(), os.Stderr)
|
||||||
|
assert.ErrorContains(t, err, "failed waiting for authentication: timed out waiting for device token")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("canceled context", func(t *testing.T) {
|
||||||
|
getDeviceToken := func(audience string) (api.State, error) {
|
||||||
|
return api.State{
|
||||||
|
DeviceCode: "device-code",
|
||||||
|
UserCode: "0123-4567",
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
waitForDeviceToken := func(state api.State) (api.TokenResponse, error) {
|
||||||
|
// make sure that the context is cancelled before this returns
|
||||||
|
time.Sleep(500 * time.Millisecond)
|
||||||
|
return api.TokenResponse{
|
||||||
|
AccessToken: validToken,
|
||||||
|
RefreshToken: "refresh-token",
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
a := &testAPI{
|
||||||
|
getDeviceToken: getDeviceToken,
|
||||||
|
waitForDeviceToken: waitForDeviceToken,
|
||||||
|
}
|
||||||
|
manager := OAuthManager{
|
||||||
|
api: a,
|
||||||
|
openBrowser: func(url string) error {
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
_, err := manager.LoginDevice(ctx, os.Stderr)
|
||||||
|
assert.ErrorContains(t, err, "login canceled")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLogout(t *testing.T) {
|
||||||
|
t.Run("successfully revokes token", func(t *testing.T) {
|
||||||
|
var receivedToken string
|
||||||
|
a := &testAPI{
|
||||||
|
revokeToken: func(token string) error {
|
||||||
|
receivedToken = token
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
store := newStore(map[string]types.AuthConfig{
|
||||||
|
"https://index.docker.io/v1/access-token": {
|
||||||
|
Password: validToken,
|
||||||
|
},
|
||||||
|
"https://index.docker.io/v1/refresh-token": {
|
||||||
|
Password: "a-refresh-token..client-id",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
manager := OAuthManager{
|
||||||
|
store: credentials.NewFileStore(store),
|
||||||
|
api: a,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := manager.Logout(context.Background())
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.Equal(t, receivedToken, "a-refresh-token")
|
||||||
|
assert.Equal(t, len(store.configs), 0)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("error revoking token", func(t *testing.T) {
|
||||||
|
a := &testAPI{
|
||||||
|
revokeToken: func(token string) error {
|
||||||
|
return errors.New("couldn't reach tenant")
|
||||||
|
},
|
||||||
|
}
|
||||||
|
store := newStore(map[string]types.AuthConfig{
|
||||||
|
"https://index.docker.io/v1/access-token": {
|
||||||
|
Password: validToken,
|
||||||
|
},
|
||||||
|
"https://index.docker.io/v1/refresh-token": {
|
||||||
|
Password: "a-refresh-token..client-id",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
manager := OAuthManager{
|
||||||
|
store: credentials.NewFileStore(store),
|
||||||
|
api: a,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := manager.Logout(context.Background())
|
||||||
|
assert.ErrorContains(t, err, "credentials erased successfully, but there was a failure to revoke the OAuth refresh token with the tenant: couldn't reach tenant")
|
||||||
|
|
||||||
|
assert.Equal(t, len(store.configs), 0)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("invalid refresh token", func(t *testing.T) {
|
||||||
|
var triedRevoke bool
|
||||||
|
a := &testAPI{
|
||||||
|
revokeToken: func(token string) error {
|
||||||
|
triedRevoke = true
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
store := newStore(map[string]types.AuthConfig{
|
||||||
|
"https://index.docker.io/v1/access-token": {
|
||||||
|
Password: validToken,
|
||||||
|
},
|
||||||
|
"https://index.docker.io/v1/refresh-token": {
|
||||||
|
Password: "a-refresh-token-without-client-id",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
manager := OAuthManager{
|
||||||
|
store: credentials.NewFileStore(store),
|
||||||
|
api: a,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := manager.Logout(context.Background())
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.Check(t, !triedRevoke)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("no refresh token", func(t *testing.T) {
|
||||||
|
a := &testAPI{}
|
||||||
|
var triedRevoke bool
|
||||||
|
revokeToken := func(token string) error {
|
||||||
|
triedRevoke = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
a.revokeToken = revokeToken
|
||||||
|
store := newStore(map[string]types.AuthConfig{})
|
||||||
|
manager := OAuthManager{
|
||||||
|
store: credentials.NewFileStore(store),
|
||||||
|
api: a,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := manager.Logout(context.Background())
|
||||||
|
assert.NilError(t, err)
|
||||||
|
|
||||||
|
assert.Check(t, !triedRevoke)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ api.OAuthAPI = &testAPI{}
|
||||||
|
|
||||||
|
type testAPI struct {
|
||||||
|
getDeviceToken func(audience string) (api.State, error)
|
||||||
|
waitForDeviceToken func(state api.State) (api.TokenResponse, error)
|
||||||
|
refresh func(token string) (api.TokenResponse, error)
|
||||||
|
revokeToken func(token string) error
|
||||||
|
getAutoPAT func(audience string, res api.TokenResponse) (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *testAPI) GetDeviceCode(_ context.Context, audience string) (api.State, error) {
|
||||||
|
if t.getDeviceToken != nil {
|
||||||
|
return t.getDeviceToken(audience)
|
||||||
|
}
|
||||||
|
return api.State{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *testAPI) WaitForDeviceToken(_ context.Context, state api.State) (api.TokenResponse, error) {
|
||||||
|
if t.waitForDeviceToken != nil {
|
||||||
|
return t.waitForDeviceToken(state)
|
||||||
|
}
|
||||||
|
return api.TokenResponse{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *testAPI) Refresh(_ context.Context, token string) (api.TokenResponse, error) {
|
||||||
|
if t.refresh != nil {
|
||||||
|
return t.refresh(token)
|
||||||
|
}
|
||||||
|
return api.TokenResponse{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *testAPI) RevokeToken(_ context.Context, token string) error {
|
||||||
|
if t.revokeToken != nil {
|
||||||
|
return t.revokeToken(token)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *testAPI) GetAutoPAT(_ context.Context, audience string, res api.TokenResponse) (string, error) {
|
||||||
|
if t.getAutoPAT != nil {
|
||||||
|
return t.getAutoPAT(audience, res)
|
||||||
|
}
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type fakeStore struct {
|
||||||
|
configs map[string]types.AuthConfig
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeStore) Save() error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeStore) GetAuthConfigs() map[string]types.AuthConfig {
|
||||||
|
return f.configs
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeStore) GetFilename() string {
|
||||||
|
return "/tmp/docker-fakestore"
|
||||||
|
}
|
||||||
|
|
||||||
|
func newStore(auths map[string]types.AuthConfig) *fakeStore {
|
||||||
|
return &fakeStore{configs: auths}
|
||||||
|
}
|
|
@ -0,0 +1,28 @@
|
||||||
|
package manager
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/docker/cli/cli/config/credentials"
|
||||||
|
"github.com/docker/cli/cli/version"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
audience = "https://hub.docker.com"
|
||||||
|
tenant = "login.docker.com"
|
||||||
|
clientID = "L4v0dmlNBpYUjGGab0C2JtgTgXr1Qz4d"
|
||||||
|
)
|
||||||
|
|
||||||
|
func NewManager(store credentials.Store) *OAuthManager {
|
||||||
|
cliVersion := strings.ReplaceAll(version.Version, ".", "_")
|
||||||
|
options := OAuthManagerOptions{
|
||||||
|
Store: store,
|
||||||
|
Audience: audience,
|
||||||
|
ClientID: clientID,
|
||||||
|
Tenant: tenant,
|
||||||
|
DeviceName: fmt.Sprintf("docker-cli:%s:%s-%s", cliVersion, runtime.GOOS, runtime.GOARCH),
|
||||||
|
}
|
||||||
|
return New(options)
|
||||||
|
}
|
|
@ -18,6 +18,7 @@ require (
|
||||||
github.com/docker/go-connections v0.5.0
|
github.com/docker/go-connections v0.5.0
|
||||||
github.com/docker/go-units v0.5.0
|
github.com/docker/go-units v0.5.0
|
||||||
github.com/fvbommel/sortorder v1.1.0
|
github.com/fvbommel/sortorder v1.1.0
|
||||||
|
github.com/go-jose/go-jose/v3 v3.0.3
|
||||||
github.com/go-viper/mapstructure/v2 v2.0.0
|
github.com/go-viper/mapstructure/v2 v2.0.0
|
||||||
github.com/gogo/protobuf v1.3.2
|
github.com/gogo/protobuf v1.3.2
|
||||||
github.com/google/go-cmp v0.6.0
|
github.com/google/go-cmp v0.6.0
|
||||||
|
@ -79,11 +80,13 @@ require (
|
||||||
github.com/moby/sys/symlink v0.3.0 // indirect
|
github.com/moby/sys/symlink v0.3.0 // indirect
|
||||||
github.com/moby/sys/user v0.3.0 // indirect
|
github.com/moby/sys/user v0.3.0 // indirect
|
||||||
github.com/moby/sys/userns v0.1.0 // indirect
|
github.com/moby/sys/userns v0.1.0 // indirect
|
||||||
|
github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c
|
||||||
github.com/prometheus/client_golang v1.17.0 // indirect
|
github.com/prometheus/client_golang v1.17.0 // indirect
|
||||||
github.com/prometheus/client_model v0.5.0 // indirect
|
github.com/prometheus/client_model v0.5.0 // indirect
|
||||||
github.com/prometheus/common v0.44.0 // indirect
|
github.com/prometheus/common v0.44.0 // indirect
|
||||||
github.com/prometheus/procfs v0.15.1 // indirect
|
github.com/prometheus/procfs v0.15.1 // indirect
|
||||||
github.com/rivo/uniseg v0.2.0 // indirect
|
github.com/rivo/uniseg v0.2.0 // indirect
|
||||||
|
github.com/stretchr/testify v1.9.0 // indirect
|
||||||
github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
|
github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
|
||||||
github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
|
github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
|
||||||
go.etcd.io/etcd/raft/v3 v3.5.6 // indirect
|
go.etcd.io/etcd/raft/v3 v3.5.6 // indirect
|
||||||
|
|
39
vendor.sum
39
vendor.sum
|
@ -83,6 +83,8 @@ github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMo
|
||||||
github.com/fvbommel/sortorder v1.1.0 h1:fUmoe+HLsBTctBDoaBwpQo5N+nrCp8g/BjKb/6ZQmYw=
|
github.com/fvbommel/sortorder v1.1.0 h1:fUmoe+HLsBTctBDoaBwpQo5N+nrCp8g/BjKb/6ZQmYw=
|
||||||
github.com/fvbommel/sortorder v1.1.0/go.mod h1:uk88iVf1ovNn1iLfgUVU2F9o5eO30ui720w+kxuqRs0=
|
github.com/fvbommel/sortorder v1.1.0/go.mod h1:uk88iVf1ovNn1iLfgUVU2F9o5eO30ui720w+kxuqRs0=
|
||||||
github.com/getsentry/raven-go v0.2.0/go.mod h1:KungGk8q33+aIAZUIVWZDr2OfAEBsO49PX4NzFV5kcQ=
|
github.com/getsentry/raven-go v0.2.0/go.mod h1:KungGk8q33+aIAZUIVWZDr2OfAEBsO49PX4NzFV5kcQ=
|
||||||
|
github.com/go-jose/go-jose/v3 v3.0.3 h1:fFKWeig/irsp7XD2zBxvnmA/XaRWp5V3CBsZXJF7G7k=
|
||||||
|
github.com/go-jose/go-jose/v3 v3.0.3/go.mod h1:5b+7YgP7ZICgJDBdfjZaIt+H/9L9T/YQrVfLAMboGkQ=
|
||||||
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
|
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
|
||||||
github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
|
github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
|
||||||
github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
|
github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
|
||||||
|
@ -118,6 +120,7 @@ github.com/google/certificate-transparency-go v1.1.4 h1:hCyXHDbtqlr/lMXU0D4Wgbal
|
||||||
github.com/google/certificate-transparency-go v1.1.4/go.mod h1:D6lvbfwckhNrbM9WVl1EVeMOyzC19mpIjMOI4nxBHtQ=
|
github.com/google/certificate-transparency-go v1.1.4/go.mod h1:D6lvbfwckhNrbM9WVl1EVeMOyzC19mpIjMOI4nxBHtQ=
|
||||||
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
|
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
|
||||||
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||||
|
github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||||
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||||
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
|
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
|
||||||
|
@ -210,6 +213,8 @@ github.com/opencontainers/image-spec v1.1.0 h1:8SG7/vwALn54lVB/0yZ/MMwhFrPYtpEHQ
|
||||||
github.com/opencontainers/image-spec v1.1.0/go.mod h1:W4s4sFTMaBeK1BQLXbG4AdM2szdn85PY75RI83NrTrM=
|
github.com/opencontainers/image-spec v1.1.0/go.mod h1:W4s4sFTMaBeK1BQLXbG4AdM2szdn85PY75RI83NrTrM=
|
||||||
github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU=
|
github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU=
|
||||||
github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
|
github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
|
||||||
|
github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ=
|
||||||
|
github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU=
|
||||||
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||||
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||||
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
|
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
|
||||||
|
@ -268,8 +273,8 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV
|
||||||
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
||||||
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
|
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
|
||||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
|
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
|
||||||
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
|
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||||
github.com/theupdateframework/notary v0.7.1-0.20210315103452-bf96a202a09a h1:tlJ7tGUHvcvL1v3yR6NcCc9nOqh2L+CG6HWrYQtwzQ0=
|
github.com/theupdateframework/notary v0.7.1-0.20210315103452-bf96a202a09a h1:tlJ7tGUHvcvL1v3yR6NcCc9nOqh2L+CG6HWrYQtwzQ0=
|
||||||
github.com/theupdateframework/notary v0.7.1-0.20210315103452-bf96a202a09a/go.mod h1:Y94A6rPp2OwNfP/7vmf8O2xx2IykP8pPXQ1DLouGnEw=
|
github.com/theupdateframework/notary v0.7.1-0.20210315103452-bf96a202a09a/go.mod h1:Y94A6rPp2OwNfP/7vmf8O2xx2IykP8pPXQ1DLouGnEw=
|
||||||
github.com/tonistiigi/go-rosetta v0.0.0-20200727161949-f79598599c5d h1:wvQZpqy8p0D/FUia6ipKDhXrzPzBVJE4PZyPc5+5Ay0=
|
github.com/tonistiigi/go-rosetta v0.0.0-20200727161949-f79598599c5d h1:wvQZpqy8p0D/FUia6ipKDhXrzPzBVJE4PZyPc5+5Ay0=
|
||||||
|
@ -285,6 +290,7 @@ github.com/xeipuuv/gojsonschema v1.2.0 h1:LhYJRs+L4fBtjZUfuSZIKGeVu0QRy8e5Xi7D17
|
||||||
github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y=
|
github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y=
|
||||||
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||||
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||||
|
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
||||||
github.com/zmap/zcrypto v0.0.0-20210511125630-18f1e0152cfc h1:zkGwegkOW709y0oiAraH/3D8njopUR/pARHv4tZZ6pw=
|
github.com/zmap/zcrypto v0.0.0-20210511125630-18f1e0152cfc h1:zkGwegkOW709y0oiAraH/3D8njopUR/pARHv4tZZ6pw=
|
||||||
github.com/zmap/zcrypto v0.0.0-20210511125630-18f1e0152cfc/go.mod h1:FM4U1E3NzlNMRnSUTU3P1UdukWhYGifqEsjk9fn7BCk=
|
github.com/zmap/zcrypto v0.0.0-20210511125630-18f1e0152cfc/go.mod h1:FM4U1E3NzlNMRnSUTU3P1UdukWhYGifqEsjk9fn7BCk=
|
||||||
github.com/zmap/zlint/v3 v3.1.0 h1:WjVytZo79m/L1+/Mlphl09WBob6YTGljN5IGWZFpAv0=
|
github.com/zmap/zlint/v3 v3.1.0 h1:WjVytZo79m/L1+/Mlphl09WBob6YTGljN5IGWZFpAv0=
|
||||||
|
@ -326,10 +332,14 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U
|
||||||
golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||||
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||||
golang.org/x/crypto v0.0.0-20201117144127-c1f2f97bffc9/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
|
golang.org/x/crypto v0.0.0-20201117144127-c1f2f97bffc9/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
|
||||||
|
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
||||||
|
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
|
||||||
golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI=
|
golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI=
|
||||||
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
|
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
|
||||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||||
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||||
|
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
||||||
|
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||||
golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||||
golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||||
|
@ -337,6 +347,10 @@ golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLL
|
||||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||||
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||||
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
||||||
|
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
||||||
|
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
||||||
|
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
|
||||||
|
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
|
||||||
golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
|
golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
|
||||||
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
|
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
|
||||||
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
|
@ -345,6 +359,8 @@ golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJ
|
||||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
|
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
|
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
|
golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
|
||||||
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||||
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
|
@ -356,16 +372,33 @@ golang.org/x/sys v0.0.0-20190801041406-cbf593c0f2f3/go.mod h1:h1NjWce9XRLGQEsW7w
|
||||||
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
|
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
|
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.0.0-20210616094352-59db8d763f22/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.0.0-20210616094352-59db8d763f22/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
|
golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
|
||||||
golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
|
golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
|
||||||
|
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||||
|
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||||
|
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
|
||||||
|
golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
|
||||||
|
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
|
||||||
golang.org/x/term v0.20.0 h1:VnkxpohqXaOBYJtBmEppKUG6mXpi+4O6purfc2+sMhw=
|
golang.org/x/term v0.20.0 h1:VnkxpohqXaOBYJtBmEppKUG6mXpi+4O6purfc2+sMhw=
|
||||||
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
|
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
|
||||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||||
|
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||||
|
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
|
||||||
|
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
|
||||||
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
golang.org/x/text v0.15.0 h1:h1V/4gjBv8v9cjcR6+AR5+/cIYK5N/WAgiv4xlsEtAk=
|
golang.org/x/text v0.15.0 h1:h1V/4gjBv8v9cjcR6+AR5+/cIYK5N/WAgiv4xlsEtAk=
|
||||||
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
|
golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
|
||||||
|
@ -375,6 +408,8 @@ golang.org/x/tools v0.0.0-20181030221726-6c7e314b6563/go.mod h1:n7NCudcB/nEzxVGm
|
||||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||||
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
||||||
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
||||||
|
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
|
||||||
|
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
|
||||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
jose-util/jose-util
|
||||||
|
jose-util.t.err
|
|
@ -0,0 +1,53 @@
|
||||||
|
# https://github.com/golangci/golangci-lint
|
||||||
|
|
||||||
|
run:
|
||||||
|
skip-files:
|
||||||
|
- doc_test.go
|
||||||
|
modules-download-mode: readonly
|
||||||
|
|
||||||
|
linters:
|
||||||
|
enable-all: true
|
||||||
|
disable:
|
||||||
|
- gochecknoglobals
|
||||||
|
- goconst
|
||||||
|
- lll
|
||||||
|
- maligned
|
||||||
|
- nakedret
|
||||||
|
- scopelint
|
||||||
|
- unparam
|
||||||
|
- funlen # added in 1.18 (requires go-jose changes before it can be enabled)
|
||||||
|
|
||||||
|
linters-settings:
|
||||||
|
gocyclo:
|
||||||
|
min-complexity: 35
|
||||||
|
|
||||||
|
issues:
|
||||||
|
exclude-rules:
|
||||||
|
- text: "don't use ALL_CAPS in Go names"
|
||||||
|
linters:
|
||||||
|
- golint
|
||||||
|
- text: "hardcoded credentials"
|
||||||
|
linters:
|
||||||
|
- gosec
|
||||||
|
- text: "weak cryptographic primitive"
|
||||||
|
linters:
|
||||||
|
- gosec
|
||||||
|
- path: json/
|
||||||
|
linters:
|
||||||
|
- dupl
|
||||||
|
- errcheck
|
||||||
|
- gocritic
|
||||||
|
- gocyclo
|
||||||
|
- golint
|
||||||
|
- govet
|
||||||
|
- ineffassign
|
||||||
|
- staticcheck
|
||||||
|
- structcheck
|
||||||
|
- stylecheck
|
||||||
|
- unused
|
||||||
|
- path: _test\.go
|
||||||
|
linters:
|
||||||
|
- scopelint
|
||||||
|
- path: jwk.go
|
||||||
|
linters:
|
||||||
|
- gocyclo
|
|
@ -0,0 +1,33 @@
|
||||||
|
language: go
|
||||||
|
|
||||||
|
matrix:
|
||||||
|
fast_finish: true
|
||||||
|
allow_failures:
|
||||||
|
- go: tip
|
||||||
|
|
||||||
|
go:
|
||||||
|
- "1.13.x"
|
||||||
|
- "1.14.x"
|
||||||
|
- tip
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- export PATH=$HOME/.local/bin:$PATH
|
||||||
|
|
||||||
|
before_install:
|
||||||
|
- go get -u github.com/mattn/goveralls github.com/wadey/gocovmerge
|
||||||
|
- curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.18.0
|
||||||
|
- pip install cram --user
|
||||||
|
|
||||||
|
script:
|
||||||
|
- go test -v -covermode=count -coverprofile=profile.cov .
|
||||||
|
- go test -v -covermode=count -coverprofile=cryptosigner/profile.cov ./cryptosigner
|
||||||
|
- go test -v -covermode=count -coverprofile=cipher/profile.cov ./cipher
|
||||||
|
- go test -v -covermode=count -coverprofile=jwt/profile.cov ./jwt
|
||||||
|
- go test -v ./json # no coverage for forked encoding/json package
|
||||||
|
- golangci-lint run
|
||||||
|
- cd jose-util && go build && PATH=$PWD:$PATH cram -v jose-util.t # cram tests jose-util
|
||||||
|
- cd ..
|
||||||
|
|
||||||
|
after_success:
|
||||||
|
- gocovmerge *.cov */*.cov > merged.coverprofile
|
||||||
|
- goveralls -coverprofile merged.coverprofile -service=travis-ci
|
|
@ -0,0 +1,78 @@
|
||||||
|
# v4.0.1
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- An attacker could send a JWE containing compressed data that used large
|
||||||
|
amounts of memory and CPU when decompressed by `Decrypt` or `DecryptMulti`.
|
||||||
|
Those functions now return an error if the decompressed data would exceed
|
||||||
|
250kB or 10x the compressed size (whichever is larger). Thanks to
|
||||||
|
Enze Wang@Alioth and Jianjun Chen@Zhongguancun Lab (@zer0yu and @chenjj)
|
||||||
|
for reporting.
|
||||||
|
|
||||||
|
# v4.0.0
|
||||||
|
|
||||||
|
This release makes some breaking changes in order to more thoroughly
|
||||||
|
address the vulnerabilities discussed in [Three New Attacks Against JSON Web
|
||||||
|
Tokens][1], "Sign/encrypt confusion", "Billion hash attack", and "Polyglot
|
||||||
|
token".
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- Limit JWT encryption types (exclude password or public key types) (#78)
|
||||||
|
- Enforce minimum length for HMAC keys (#85)
|
||||||
|
- jwt: match any audience in a list, rather than requiring all audiences (#81)
|
||||||
|
- jwt: accept only Compact Serialization (#75)
|
||||||
|
- jws: Add expected algorithms for signatures (#74)
|
||||||
|
- Require specifying expected algorithms for ParseEncrypted,
|
||||||
|
ParseSigned, ParseDetached, jwt.ParseEncrypted, jwt.ParseSigned,
|
||||||
|
jwt.ParseSignedAndEncrypted (#69, #74)
|
||||||
|
- Usually there is a small, known set of appropriate algorithms for a program
|
||||||
|
to use and it's a mistake to allow unexpected algorithms. For instance the
|
||||||
|
"billion hash attack" relies in part on programs accepting the PBES2
|
||||||
|
encryption algorithm and doing the necessary work even if they weren't
|
||||||
|
specifically configured to allow PBES2.
|
||||||
|
- Revert "Strip padding off base64 strings" (#82)
|
||||||
|
- The specs require base64url encoding without padding.
|
||||||
|
- Minimum supported Go version is now 1.21
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- ParseSignedCompact, ParseSignedJSON, ParseEncryptedCompact, ParseEncryptedJSON.
|
||||||
|
- These allow parsing a specific serialization, as opposed to ParseSigned and
|
||||||
|
ParseEncrypted, which try to automatically detect which serialization was
|
||||||
|
provided. It's common to require a specific serialization for a specific
|
||||||
|
protocol - for instance JWT requires Compact serialization.
|
||||||
|
|
||||||
|
[1]: https://i.blackhat.com/BH-US-23/Presentations/US-23-Tervoort-Three-New-Attacks-Against-JSON-Web-Tokens.pdf
|
||||||
|
|
||||||
|
# v3.0.3
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- Limit decompression output size to prevent a DoS. Backport from v4.0.1.
|
||||||
|
|
||||||
|
# v3.0.2
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- DecryptMulti: handle decompression error (#19)
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- jwe/CompactSerialize: improve performance (#67)
|
||||||
|
- Increase the default number of PBKDF2 iterations to 600k (#48)
|
||||||
|
- Return the proper algorithm for ECDSA keys (#45)
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- Add Thumbprint support for opaque signers (#38)
|
||||||
|
|
||||||
|
# v3.0.1
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- Security issue: an attacker specifying a large "p2c" value can cause
|
||||||
|
JSONWebEncryption.Decrypt and JSONWebEncryption.DecryptMulti to consume large
|
||||||
|
amounts of CPU, causing a DoS. Thanks to Matt Schwager (@mschwager) for the
|
||||||
|
disclosure and to Tom Tervoort for originally publishing the category of attack.
|
||||||
|
https://i.blackhat.com/BH-US-23/Presentations/US-23-Tervoort-Three-New-Attacks-Against-JSON-Web-Tokens.pdf
|
|
@ -0,0 +1,15 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
If you would like to contribute code to go-jose you can do so through GitHub by
|
||||||
|
forking the repository and sending a pull request.
|
||||||
|
|
||||||
|
When submitting code, please make every effort to follow existing conventions
|
||||||
|
and style in order to keep the code as readable as possible. Please also make
|
||||||
|
sure all tests pass by running `go test`, and format your code with `go fmt`.
|
||||||
|
We also recommend using `golint` and `errcheck`.
|
||||||
|
|
||||||
|
Before your code can be accepted into the project you must also sign the
|
||||||
|
Individual Contributor License Agreement. We use [cla-assistant.io][1] and you
|
||||||
|
will be prompted to sign once a pull request is opened.
|
||||||
|
|
||||||
|
[1]: https://cla-assistant.io/
|
|
@ -0,0 +1,202 @@
|
||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
|
@ -0,0 +1,108 @@
|
||||||
|
# Go JOSE
|
||||||
|
|
||||||
|
### Versions
|
||||||
|
|
||||||
|
[Version 4](https://github.com/go-jose/go-jose)
|
||||||
|
([branch](https://github.com/go-jose/go-jose/),
|
||||||
|
[doc](https://pkg.go.dev/github.com/go-jose/go-jose/v4), [releases](https://github.com/go-jose/go-jose/releases)) is the current stable version:
|
||||||
|
|
||||||
|
import "github.com/go-jose/go-jose/v4"
|
||||||
|
|
||||||
|
The old [square/go-jose](https://github.com/square/go-jose) repo contains the prior v1 and v2 versions, which
|
||||||
|
are deprecated.
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
|
||||||
|
Package jose aims to provide an implementation of the Javascript Object Signing
|
||||||
|
and Encryption set of standards. This includes support for JSON Web Encryption,
|
||||||
|
JSON Web Signature, and JSON Web Token standards.
|
||||||
|
|
||||||
|
**Disclaimer**: This library contains encryption software that is subject to
|
||||||
|
the U.S. Export Administration Regulations. You may not export, re-export,
|
||||||
|
transfer or download this code or any part of it in violation of any United
|
||||||
|
States law, directive or regulation. In particular this software may not be
|
||||||
|
exported or re-exported in any form or on any media to Iran, North Sudan,
|
||||||
|
Syria, Cuba, or North Korea, or to denied persons or entities mentioned on any
|
||||||
|
US maintained blocked list.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The implementation follows the
|
||||||
|
[JSON Web Encryption](https://dx.doi.org/10.17487/RFC7516) (RFC 7516),
|
||||||
|
[JSON Web Signature](https://dx.doi.org/10.17487/RFC7515) (RFC 7515), and
|
||||||
|
[JSON Web Token](https://dx.doi.org/10.17487/RFC7519) (RFC 7519) specifications.
|
||||||
|
Tables of supported algorithms are shown below. The library supports both
|
||||||
|
the compact and JWS/JWE JSON Serialization formats, and has optional support for
|
||||||
|
multiple recipients. It also comes with a small command-line utility
|
||||||
|
([`jose-util`](https://pkg.go.dev/github.com/go-jose/go-jose/jose-util))
|
||||||
|
for dealing with JOSE messages in a shell.
|
||||||
|
|
||||||
|
**Note**: We use a forked version of the `encoding/json` package from the Go
|
||||||
|
standard library which uses case-sensitive matching for member names (instead
|
||||||
|
of [case-insensitive matching](https://www.ietf.org/mail-archive/web/json/current/msg03763.html)).
|
||||||
|
This is to avoid differences in interpretation of messages between go-jose and
|
||||||
|
libraries in other languages.
|
||||||
|
|
||||||
|
### Supported algorithms
|
||||||
|
|
||||||
|
See below for a table of supported algorithms. Algorithm identifiers match
|
||||||
|
the names in the [JSON Web Algorithms](https://dx.doi.org/10.17487/RFC7518)
|
||||||
|
standard where possible. The Godoc reference has a list of constants.
|
||||||
|
|
||||||
|
Key encryption | Algorithm identifier(s)
|
||||||
|
:------------------------- | :------------------------------
|
||||||
|
RSA-PKCS#1v1.5 | RSA1_5
|
||||||
|
RSA-OAEP | RSA-OAEP, RSA-OAEP-256
|
||||||
|
AES key wrap | A128KW, A192KW, A256KW
|
||||||
|
AES-GCM key wrap | A128GCMKW, A192GCMKW, A256GCMKW
|
||||||
|
ECDH-ES + AES key wrap | ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW
|
||||||
|
ECDH-ES (direct) | ECDH-ES<sup>1</sup>
|
||||||
|
Direct encryption | dir<sup>1</sup>
|
||||||
|
|
||||||
|
<sup>1. Not supported in multi-recipient mode</sup>
|
||||||
|
|
||||||
|
Signing / MAC | Algorithm identifier(s)
|
||||||
|
:------------------------- | :------------------------------
|
||||||
|
RSASSA-PKCS#1v1.5 | RS256, RS384, RS512
|
||||||
|
RSASSA-PSS | PS256, PS384, PS512
|
||||||
|
HMAC | HS256, HS384, HS512
|
||||||
|
ECDSA | ES256, ES384, ES512
|
||||||
|
Ed25519 | EdDSA<sup>2</sup>
|
||||||
|
|
||||||
|
<sup>2. Only available in version 2 of the package</sup>
|
||||||
|
|
||||||
|
Content encryption | Algorithm identifier(s)
|
||||||
|
:------------------------- | :------------------------------
|
||||||
|
AES-CBC+HMAC | A128CBC-HS256, A192CBC-HS384, A256CBC-HS512
|
||||||
|
AES-GCM | A128GCM, A192GCM, A256GCM
|
||||||
|
|
||||||
|
Compression | Algorithm identifiers(s)
|
||||||
|
:------------------------- | -------------------------------
|
||||||
|
DEFLATE (RFC 1951) | DEF
|
||||||
|
|
||||||
|
### Supported key types
|
||||||
|
|
||||||
|
See below for a table of supported key types. These are understood by the
|
||||||
|
library, and can be passed to corresponding functions such as `NewEncrypter` or
|
||||||
|
`NewSigner`. Each of these keys can also be wrapped in a JWK if desired, which
|
||||||
|
allows attaching a key id.
|
||||||
|
|
||||||
|
Algorithm(s) | Corresponding types
|
||||||
|
:------------------------- | -------------------------------
|
||||||
|
RSA | *[rsa.PublicKey](https://pkg.go.dev/crypto/rsa/#PublicKey), *[rsa.PrivateKey](https://pkg.go.dev/crypto/rsa/#PrivateKey)
|
||||||
|
ECDH, ECDSA | *[ecdsa.PublicKey](https://pkg.go.dev/crypto/ecdsa/#PublicKey), *[ecdsa.PrivateKey](https://pkg.go.dev/crypto/ecdsa/#PrivateKey)
|
||||||
|
EdDSA<sup>1</sup> | [ed25519.PublicKey](https://pkg.go.dev/crypto/ed25519#PublicKey), [ed25519.PrivateKey](https://pkg.go.dev/crypto/ed25519#PrivateKey)
|
||||||
|
AES, HMAC | []byte
|
||||||
|
|
||||||
|
<sup>1. Only available in version 2 or later of the package</sup>
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v3.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v3)
|
||||||
|
[![godoc](https://pkg.go.dev/badge/github.com/go-jose/go-jose/v3/jwt.svg)](https://pkg.go.dev/github.com/go-jose/go-jose/v3/jwt)
|
||||||
|
|
||||||
|
Examples can be found in the Godoc
|
||||||
|
reference for this package. The
|
||||||
|
[`jose-util`](https://github.com/go-jose/go-jose/tree/v3/jose-util)
|
||||||
|
subdirectory also contains a small command-line utility which might be useful
|
||||||
|
as an example as well.
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Security Policy
|
||||||
|
This document explains how to contact the Let's Encrypt security team to report security vulnerabilities.
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
| Version | Supported |
|
||||||
|
| ------- | ----------|
|
||||||
|
| >= v3 | ✓ |
|
||||||
|
| v2 | ✗ |
|
||||||
|
| v1 | ✗ |
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
Please see [https://letsencrypt.org/contact/#security](https://letsencrypt.org/contact/#security) for the email address to report a vulnerability. Ensure that the subject line for your report contains the word `vulnerability` and is descriptive. Your email should be acknowledged within 24 hours. If you do not receive a response within 24 hours, please follow-up again with another email.
|
|
@ -0,0 +1,595 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto"
|
||||||
|
"crypto/aes"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/ed25519"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/rsa"
|
||||||
|
"crypto/sha1"
|
||||||
|
"crypto/sha256"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"math/big"
|
||||||
|
|
||||||
|
josecipher "github.com/go-jose/go-jose/v3/cipher"
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A generic RSA-based encrypter/verifier
|
||||||
|
type rsaEncrypterVerifier struct {
|
||||||
|
publicKey *rsa.PublicKey
|
||||||
|
}
|
||||||
|
|
||||||
|
// A generic RSA-based decrypter/signer
|
||||||
|
type rsaDecrypterSigner struct {
|
||||||
|
privateKey *rsa.PrivateKey
|
||||||
|
}
|
||||||
|
|
||||||
|
// A generic EC-based encrypter/verifier
|
||||||
|
type ecEncrypterVerifier struct {
|
||||||
|
publicKey *ecdsa.PublicKey
|
||||||
|
}
|
||||||
|
|
||||||
|
type edEncrypterVerifier struct {
|
||||||
|
publicKey ed25519.PublicKey
|
||||||
|
}
|
||||||
|
|
||||||
|
// A key generator for ECDH-ES
|
||||||
|
type ecKeyGenerator struct {
|
||||||
|
size int
|
||||||
|
algID string
|
||||||
|
publicKey *ecdsa.PublicKey
|
||||||
|
}
|
||||||
|
|
||||||
|
// A generic EC-based decrypter/signer
|
||||||
|
type ecDecrypterSigner struct {
|
||||||
|
privateKey *ecdsa.PrivateKey
|
||||||
|
}
|
||||||
|
|
||||||
|
type edDecrypterSigner struct {
|
||||||
|
privateKey ed25519.PrivateKey
|
||||||
|
}
|
||||||
|
|
||||||
|
// newRSARecipient creates recipientKeyInfo based on the given key.
|
||||||
|
func newRSARecipient(keyAlg KeyAlgorithm, publicKey *rsa.PublicKey) (recipientKeyInfo, error) {
|
||||||
|
// Verify that key management algorithm is supported by this encrypter
|
||||||
|
switch keyAlg {
|
||||||
|
case RSA1_5, RSA_OAEP, RSA_OAEP_256:
|
||||||
|
default:
|
||||||
|
return recipientKeyInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
if publicKey == nil {
|
||||||
|
return recipientKeyInfo{}, errors.New("invalid public key")
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientKeyInfo{
|
||||||
|
keyAlg: keyAlg,
|
||||||
|
keyEncrypter: &rsaEncrypterVerifier{
|
||||||
|
publicKey: publicKey,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// newRSASigner creates a recipientSigInfo based on the given key.
|
||||||
|
func newRSASigner(sigAlg SignatureAlgorithm, privateKey *rsa.PrivateKey) (recipientSigInfo, error) {
|
||||||
|
// Verify that key management algorithm is supported by this encrypter
|
||||||
|
switch sigAlg {
|
||||||
|
case RS256, RS384, RS512, PS256, PS384, PS512:
|
||||||
|
default:
|
||||||
|
return recipientSigInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
if privateKey == nil {
|
||||||
|
return recipientSigInfo{}, errors.New("invalid private key")
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientSigInfo{
|
||||||
|
sigAlg: sigAlg,
|
||||||
|
publicKey: staticPublicKey(&JSONWebKey{
|
||||||
|
Key: privateKey.Public(),
|
||||||
|
}),
|
||||||
|
signer: &rsaDecrypterSigner{
|
||||||
|
privateKey: privateKey,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func newEd25519Signer(sigAlg SignatureAlgorithm, privateKey ed25519.PrivateKey) (recipientSigInfo, error) {
|
||||||
|
if sigAlg != EdDSA {
|
||||||
|
return recipientSigInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
if privateKey == nil {
|
||||||
|
return recipientSigInfo{}, errors.New("invalid private key")
|
||||||
|
}
|
||||||
|
return recipientSigInfo{
|
||||||
|
sigAlg: sigAlg,
|
||||||
|
publicKey: staticPublicKey(&JSONWebKey{
|
||||||
|
Key: privateKey.Public(),
|
||||||
|
}),
|
||||||
|
signer: &edDecrypterSigner{
|
||||||
|
privateKey: privateKey,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// newECDHRecipient creates recipientKeyInfo based on the given key.
|
||||||
|
func newECDHRecipient(keyAlg KeyAlgorithm, publicKey *ecdsa.PublicKey) (recipientKeyInfo, error) {
|
||||||
|
// Verify that key management algorithm is supported by this encrypter
|
||||||
|
switch keyAlg {
|
||||||
|
case ECDH_ES, ECDH_ES_A128KW, ECDH_ES_A192KW, ECDH_ES_A256KW:
|
||||||
|
default:
|
||||||
|
return recipientKeyInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
if publicKey == nil || !publicKey.Curve.IsOnCurve(publicKey.X, publicKey.Y) {
|
||||||
|
return recipientKeyInfo{}, errors.New("invalid public key")
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientKeyInfo{
|
||||||
|
keyAlg: keyAlg,
|
||||||
|
keyEncrypter: &ecEncrypterVerifier{
|
||||||
|
publicKey: publicKey,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// newECDSASigner creates a recipientSigInfo based on the given key.
|
||||||
|
func newECDSASigner(sigAlg SignatureAlgorithm, privateKey *ecdsa.PrivateKey) (recipientSigInfo, error) {
|
||||||
|
// Verify that key management algorithm is supported by this encrypter
|
||||||
|
switch sigAlg {
|
||||||
|
case ES256, ES384, ES512:
|
||||||
|
default:
|
||||||
|
return recipientSigInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
if privateKey == nil {
|
||||||
|
return recipientSigInfo{}, errors.New("invalid private key")
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientSigInfo{
|
||||||
|
sigAlg: sigAlg,
|
||||||
|
publicKey: staticPublicKey(&JSONWebKey{
|
||||||
|
Key: privateKey.Public(),
|
||||||
|
}),
|
||||||
|
signer: &ecDecrypterSigner{
|
||||||
|
privateKey: privateKey,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt the given payload and update the object.
|
||||||
|
func (ctx rsaEncrypterVerifier) encryptKey(cek []byte, alg KeyAlgorithm) (recipientInfo, error) {
|
||||||
|
encryptedKey, err := ctx.encrypt(cek, alg)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientInfo{
|
||||||
|
encryptedKey: encryptedKey,
|
||||||
|
header: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt the given payload. Based on the key encryption algorithm,
|
||||||
|
// this will either use RSA-PKCS1v1.5 or RSA-OAEP (with SHA-1 or SHA-256).
|
||||||
|
func (ctx rsaEncrypterVerifier) encrypt(cek []byte, alg KeyAlgorithm) ([]byte, error) {
|
||||||
|
switch alg {
|
||||||
|
case RSA1_5:
|
||||||
|
return rsa.EncryptPKCS1v15(RandReader, ctx.publicKey, cek)
|
||||||
|
case RSA_OAEP:
|
||||||
|
return rsa.EncryptOAEP(sha1.New(), RandReader, ctx.publicKey, cek, []byte{})
|
||||||
|
case RSA_OAEP_256:
|
||||||
|
return rsa.EncryptOAEP(sha256.New(), RandReader, ctx.publicKey, cek, []byte{})
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt the given payload and return the content encryption key.
|
||||||
|
func (ctx rsaDecrypterSigner) decryptKey(headers rawHeader, recipient *recipientInfo, generator keyGenerator) ([]byte, error) {
|
||||||
|
return ctx.decrypt(recipient.encryptedKey, headers.getAlgorithm(), generator)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt the given payload. Based on the key encryption algorithm,
|
||||||
|
// this will either use RSA-PKCS1v1.5 or RSA-OAEP (with SHA-1 or SHA-256).
|
||||||
|
func (ctx rsaDecrypterSigner) decrypt(jek []byte, alg KeyAlgorithm, generator keyGenerator) ([]byte, error) {
|
||||||
|
// Note: The random reader on decrypt operations is only used for blinding,
|
||||||
|
// so stubbing is meanlingless (hence the direct use of rand.Reader).
|
||||||
|
switch alg {
|
||||||
|
case RSA1_5:
|
||||||
|
defer func() {
|
||||||
|
// DecryptPKCS1v15SessionKey sometimes panics on an invalid payload
|
||||||
|
// because of an index out of bounds error, which we want to ignore.
|
||||||
|
// This has been fixed in Go 1.3.1 (released 2014/08/13), the recover()
|
||||||
|
// only exists for preventing crashes with unpatched versions.
|
||||||
|
// See: https://groups.google.com/forum/#!topic/golang-dev/7ihX6Y6kx9k
|
||||||
|
// See: https://code.google.com/p/go/source/detail?r=58ee390ff31602edb66af41ed10901ec95904d33
|
||||||
|
_ = recover()
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Perform some input validation.
|
||||||
|
keyBytes := ctx.privateKey.PublicKey.N.BitLen() / 8
|
||||||
|
if keyBytes != len(jek) {
|
||||||
|
// Input size is incorrect, the encrypted payload should always match
|
||||||
|
// the size of the public modulus (e.g. using a 2048 bit key will
|
||||||
|
// produce 256 bytes of output). Reject this since it's invalid input.
|
||||||
|
return nil, ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
cek, _, err := generator.genKey()
|
||||||
|
if err != nil {
|
||||||
|
return nil, ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
// When decrypting an RSA-PKCS1v1.5 payload, we must take precautions to
|
||||||
|
// prevent chosen-ciphertext attacks as described in RFC 3218, "Preventing
|
||||||
|
// the Million Message Attack on Cryptographic Message Syntax". We are
|
||||||
|
// therefore deliberately ignoring errors here.
|
||||||
|
_ = rsa.DecryptPKCS1v15SessionKey(rand.Reader, ctx.privateKey, jek, cek)
|
||||||
|
|
||||||
|
return cek, nil
|
||||||
|
case RSA_OAEP:
|
||||||
|
// Use rand.Reader for RSA blinding
|
||||||
|
return rsa.DecryptOAEP(sha1.New(), rand.Reader, ctx.privateKey, jek, []byte{})
|
||||||
|
case RSA_OAEP_256:
|
||||||
|
// Use rand.Reader for RSA blinding
|
||||||
|
return rsa.DecryptOAEP(sha256.New(), rand.Reader, ctx.privateKey, jek, []byte{})
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sign the given payload
|
||||||
|
func (ctx rsaDecrypterSigner) signPayload(payload []byte, alg SignatureAlgorithm) (Signature, error) {
|
||||||
|
var hash crypto.Hash
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case RS256, PS256:
|
||||||
|
hash = crypto.SHA256
|
||||||
|
case RS384, PS384:
|
||||||
|
hash = crypto.SHA384
|
||||||
|
case RS512, PS512:
|
||||||
|
hash = crypto.SHA512
|
||||||
|
default:
|
||||||
|
return Signature{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
hasher := hash.New()
|
||||||
|
|
||||||
|
// According to documentation, Write() on hash never fails
|
||||||
|
_, _ = hasher.Write(payload)
|
||||||
|
hashed := hasher.Sum(nil)
|
||||||
|
|
||||||
|
var out []byte
|
||||||
|
var err error
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case RS256, RS384, RS512:
|
||||||
|
// TODO(https://github.com/go-jose/go-jose/issues/40): As of go1.20, the
|
||||||
|
// random parameter is legacy and ignored, and it can be nil.
|
||||||
|
// https://cs.opensource.google/go/go/+/refs/tags/go1.20:src/crypto/rsa/pkcs1v15.go;l=263;bpv=0;bpt=1
|
||||||
|
out, err = rsa.SignPKCS1v15(RandReader, ctx.privateKey, hash, hashed)
|
||||||
|
case PS256, PS384, PS512:
|
||||||
|
out, err = rsa.SignPSS(RandReader, ctx.privateKey, hash, hashed, &rsa.PSSOptions{
|
||||||
|
SaltLength: rsa.PSSSaltLengthEqualsHash,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return Signature{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return Signature{
|
||||||
|
Signature: out,
|
||||||
|
protected: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify the given payload
|
||||||
|
func (ctx rsaEncrypterVerifier) verifyPayload(payload []byte, signature []byte, alg SignatureAlgorithm) error {
|
||||||
|
var hash crypto.Hash
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case RS256, PS256:
|
||||||
|
hash = crypto.SHA256
|
||||||
|
case RS384, PS384:
|
||||||
|
hash = crypto.SHA384
|
||||||
|
case RS512, PS512:
|
||||||
|
hash = crypto.SHA512
|
||||||
|
default:
|
||||||
|
return ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
hasher := hash.New()
|
||||||
|
|
||||||
|
// According to documentation, Write() on hash never fails
|
||||||
|
_, _ = hasher.Write(payload)
|
||||||
|
hashed := hasher.Sum(nil)
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case RS256, RS384, RS512:
|
||||||
|
return rsa.VerifyPKCS1v15(ctx.publicKey, hash, hashed, signature)
|
||||||
|
case PS256, PS384, PS512:
|
||||||
|
return rsa.VerifyPSS(ctx.publicKey, hash, hashed, signature, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
return ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt the given payload and update the object.
|
||||||
|
func (ctx ecEncrypterVerifier) encryptKey(cek []byte, alg KeyAlgorithm) (recipientInfo, error) {
|
||||||
|
switch alg {
|
||||||
|
case ECDH_ES:
|
||||||
|
// ECDH-ES mode doesn't wrap a key, the shared secret is used directly as the key.
|
||||||
|
return recipientInfo{
|
||||||
|
header: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
case ECDH_ES_A128KW, ECDH_ES_A192KW, ECDH_ES_A256KW:
|
||||||
|
default:
|
||||||
|
return recipientInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
generator := ecKeyGenerator{
|
||||||
|
algID: string(alg),
|
||||||
|
publicKey: ctx.publicKey,
|
||||||
|
}
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case ECDH_ES_A128KW:
|
||||||
|
generator.size = 16
|
||||||
|
case ECDH_ES_A192KW:
|
||||||
|
generator.size = 24
|
||||||
|
case ECDH_ES_A256KW:
|
||||||
|
generator.size = 32
|
||||||
|
}
|
||||||
|
|
||||||
|
kek, header, err := generator.genKey()
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
block, err := aes.NewCipher(kek)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
jek, err := josecipher.KeyWrap(block, cek)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientInfo{
|
||||||
|
encryptedKey: jek,
|
||||||
|
header: &header,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get key size for EC key generator
|
||||||
|
func (ctx ecKeyGenerator) keySize() int {
|
||||||
|
return ctx.size
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get a content encryption key for ECDH-ES
|
||||||
|
func (ctx ecKeyGenerator) genKey() ([]byte, rawHeader, error) {
|
||||||
|
priv, err := ecdsa.GenerateKey(ctx.publicKey.Curve, RandReader)
|
||||||
|
if err != nil {
|
||||||
|
return nil, rawHeader{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
out := josecipher.DeriveECDHES(ctx.algID, []byte{}, []byte{}, priv, ctx.publicKey, ctx.size)
|
||||||
|
|
||||||
|
b, err := json.Marshal(&JSONWebKey{
|
||||||
|
Key: &priv.PublicKey,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
headers := rawHeader{
|
||||||
|
headerEPK: makeRawMessage(b),
|
||||||
|
}
|
||||||
|
|
||||||
|
return out, headers, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt the given payload and return the content encryption key.
|
||||||
|
func (ctx ecDecrypterSigner) decryptKey(headers rawHeader, recipient *recipientInfo, generator keyGenerator) ([]byte, error) {
|
||||||
|
epk, err := headers.getEPK()
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid epk header")
|
||||||
|
}
|
||||||
|
if epk == nil {
|
||||||
|
return nil, errors.New("go-jose/go-jose: missing epk header")
|
||||||
|
}
|
||||||
|
|
||||||
|
publicKey, ok := epk.Key.(*ecdsa.PublicKey)
|
||||||
|
if publicKey == nil || !ok {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid epk header")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !ctx.privateKey.Curve.IsOnCurve(publicKey.X, publicKey.Y) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid public key in epk header")
|
||||||
|
}
|
||||||
|
|
||||||
|
apuData, err := headers.getAPU()
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid apu header")
|
||||||
|
}
|
||||||
|
apvData, err := headers.getAPV()
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid apv header")
|
||||||
|
}
|
||||||
|
|
||||||
|
deriveKey := func(algID string, size int) []byte {
|
||||||
|
return josecipher.DeriveECDHES(algID, apuData.bytes(), apvData.bytes(), ctx.privateKey, publicKey, size)
|
||||||
|
}
|
||||||
|
|
||||||
|
var keySize int
|
||||||
|
|
||||||
|
algorithm := headers.getAlgorithm()
|
||||||
|
switch algorithm {
|
||||||
|
case ECDH_ES:
|
||||||
|
// ECDH-ES uses direct key agreement, no key unwrapping necessary.
|
||||||
|
return deriveKey(string(headers.getEncryption()), generator.keySize()), nil
|
||||||
|
case ECDH_ES_A128KW:
|
||||||
|
keySize = 16
|
||||||
|
case ECDH_ES_A192KW:
|
||||||
|
keySize = 24
|
||||||
|
case ECDH_ES_A256KW:
|
||||||
|
keySize = 32
|
||||||
|
default:
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
key := deriveKey(string(algorithm), keySize)
|
||||||
|
block, err := aes.NewCipher(key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return josecipher.KeyUnwrap(block, recipient.encryptedKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx edDecrypterSigner) signPayload(payload []byte, alg SignatureAlgorithm) (Signature, error) {
|
||||||
|
if alg != EdDSA {
|
||||||
|
return Signature{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
sig, err := ctx.privateKey.Sign(RandReader, payload, crypto.Hash(0))
|
||||||
|
if err != nil {
|
||||||
|
return Signature{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return Signature{
|
||||||
|
Signature: sig,
|
||||||
|
protected: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx edEncrypterVerifier) verifyPayload(payload []byte, signature []byte, alg SignatureAlgorithm) error {
|
||||||
|
if alg != EdDSA {
|
||||||
|
return ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
ok := ed25519.Verify(ctx.publicKey, payload, signature)
|
||||||
|
if !ok {
|
||||||
|
return errors.New("go-jose/go-jose: ed25519 signature failed to verify")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sign the given payload
|
||||||
|
func (ctx ecDecrypterSigner) signPayload(payload []byte, alg SignatureAlgorithm) (Signature, error) {
|
||||||
|
var expectedBitSize int
|
||||||
|
var hash crypto.Hash
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case ES256:
|
||||||
|
expectedBitSize = 256
|
||||||
|
hash = crypto.SHA256
|
||||||
|
case ES384:
|
||||||
|
expectedBitSize = 384
|
||||||
|
hash = crypto.SHA384
|
||||||
|
case ES512:
|
||||||
|
expectedBitSize = 521
|
||||||
|
hash = crypto.SHA512
|
||||||
|
}
|
||||||
|
|
||||||
|
curveBits := ctx.privateKey.Curve.Params().BitSize
|
||||||
|
if expectedBitSize != curveBits {
|
||||||
|
return Signature{}, fmt.Errorf("go-jose/go-jose: expected %d bit key, got %d bits instead", expectedBitSize, curveBits)
|
||||||
|
}
|
||||||
|
|
||||||
|
hasher := hash.New()
|
||||||
|
|
||||||
|
// According to documentation, Write() on hash never fails
|
||||||
|
_, _ = hasher.Write(payload)
|
||||||
|
hashed := hasher.Sum(nil)
|
||||||
|
|
||||||
|
r, s, err := ecdsa.Sign(RandReader, ctx.privateKey, hashed)
|
||||||
|
if err != nil {
|
||||||
|
return Signature{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
keyBytes := curveBits / 8
|
||||||
|
if curveBits%8 > 0 {
|
||||||
|
keyBytes++
|
||||||
|
}
|
||||||
|
|
||||||
|
// We serialize the outputs (r and s) into big-endian byte arrays and pad
|
||||||
|
// them with zeros on the left to make sure the sizes work out. Both arrays
|
||||||
|
// must be keyBytes long, and the output must be 2*keyBytes long.
|
||||||
|
rBytes := r.Bytes()
|
||||||
|
rBytesPadded := make([]byte, keyBytes)
|
||||||
|
copy(rBytesPadded[keyBytes-len(rBytes):], rBytes)
|
||||||
|
|
||||||
|
sBytes := s.Bytes()
|
||||||
|
sBytesPadded := make([]byte, keyBytes)
|
||||||
|
copy(sBytesPadded[keyBytes-len(sBytes):], sBytes)
|
||||||
|
|
||||||
|
out := append(rBytesPadded, sBytesPadded...)
|
||||||
|
|
||||||
|
return Signature{
|
||||||
|
Signature: out,
|
||||||
|
protected: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify the given payload
|
||||||
|
func (ctx ecEncrypterVerifier) verifyPayload(payload []byte, signature []byte, alg SignatureAlgorithm) error {
|
||||||
|
var keySize int
|
||||||
|
var hash crypto.Hash
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case ES256:
|
||||||
|
keySize = 32
|
||||||
|
hash = crypto.SHA256
|
||||||
|
case ES384:
|
||||||
|
keySize = 48
|
||||||
|
hash = crypto.SHA384
|
||||||
|
case ES512:
|
||||||
|
keySize = 66
|
||||||
|
hash = crypto.SHA512
|
||||||
|
default:
|
||||||
|
return ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(signature) != 2*keySize {
|
||||||
|
return fmt.Errorf("go-jose/go-jose: invalid signature size, have %d bytes, wanted %d", len(signature), 2*keySize)
|
||||||
|
}
|
||||||
|
|
||||||
|
hasher := hash.New()
|
||||||
|
|
||||||
|
// According to documentation, Write() on hash never fails
|
||||||
|
_, _ = hasher.Write(payload)
|
||||||
|
hashed := hasher.Sum(nil)
|
||||||
|
|
||||||
|
r := big.NewInt(0).SetBytes(signature[:keySize])
|
||||||
|
s := big.NewInt(0).SetBytes(signature[keySize:])
|
||||||
|
|
||||||
|
match := ecdsa.Verify(ctx.publicKey, hashed, r, s)
|
||||||
|
if !match {
|
||||||
|
return errors.New("go-jose/go-jose: ecdsa signature failed to verify")
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
|
@ -0,0 +1,196 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package josecipher
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/cipher"
|
||||||
|
"crypto/hmac"
|
||||||
|
"crypto/sha256"
|
||||||
|
"crypto/sha512"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/binary"
|
||||||
|
"errors"
|
||||||
|
"hash"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
nonceBytes = 16
|
||||||
|
)
|
||||||
|
|
||||||
|
// NewCBCHMAC instantiates a new AEAD based on CBC+HMAC.
|
||||||
|
func NewCBCHMAC(key []byte, newBlockCipher func([]byte) (cipher.Block, error)) (cipher.AEAD, error) {
|
||||||
|
keySize := len(key) / 2
|
||||||
|
integrityKey := key[:keySize]
|
||||||
|
encryptionKey := key[keySize:]
|
||||||
|
|
||||||
|
blockCipher, err := newBlockCipher(encryptionKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var hash func() hash.Hash
|
||||||
|
switch keySize {
|
||||||
|
case 16:
|
||||||
|
hash = sha256.New
|
||||||
|
case 24:
|
||||||
|
hash = sha512.New384
|
||||||
|
case 32:
|
||||||
|
hash = sha512.New
|
||||||
|
}
|
||||||
|
|
||||||
|
return &cbcAEAD{
|
||||||
|
hash: hash,
|
||||||
|
blockCipher: blockCipher,
|
||||||
|
authtagBytes: keySize,
|
||||||
|
integrityKey: integrityKey,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// An AEAD based on CBC+HMAC
|
||||||
|
type cbcAEAD struct {
|
||||||
|
hash func() hash.Hash
|
||||||
|
authtagBytes int
|
||||||
|
integrityKey []byte
|
||||||
|
blockCipher cipher.Block
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *cbcAEAD) NonceSize() int {
|
||||||
|
return nonceBytes
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *cbcAEAD) Overhead() int {
|
||||||
|
// Maximum overhead is block size (for padding) plus auth tag length, where
|
||||||
|
// the length of the auth tag is equivalent to the key size.
|
||||||
|
return ctx.blockCipher.BlockSize() + ctx.authtagBytes
|
||||||
|
}
|
||||||
|
|
||||||
|
// Seal encrypts and authenticates the plaintext.
|
||||||
|
func (ctx *cbcAEAD) Seal(dst, nonce, plaintext, data []byte) []byte {
|
||||||
|
// Output buffer -- must take care not to mangle plaintext input.
|
||||||
|
ciphertext := make([]byte, uint64(len(plaintext))+uint64(ctx.Overhead()))[:len(plaintext)]
|
||||||
|
copy(ciphertext, plaintext)
|
||||||
|
ciphertext = padBuffer(ciphertext, ctx.blockCipher.BlockSize())
|
||||||
|
|
||||||
|
cbc := cipher.NewCBCEncrypter(ctx.blockCipher, nonce)
|
||||||
|
|
||||||
|
cbc.CryptBlocks(ciphertext, ciphertext)
|
||||||
|
authtag := ctx.computeAuthTag(data, nonce, ciphertext)
|
||||||
|
|
||||||
|
ret, out := resize(dst, uint64(len(dst))+uint64(len(ciphertext))+uint64(len(authtag)))
|
||||||
|
copy(out, ciphertext)
|
||||||
|
copy(out[len(ciphertext):], authtag)
|
||||||
|
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open decrypts and authenticates the ciphertext.
|
||||||
|
func (ctx *cbcAEAD) Open(dst, nonce, ciphertext, data []byte) ([]byte, error) {
|
||||||
|
if len(ciphertext) < ctx.authtagBytes {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid ciphertext (too short)")
|
||||||
|
}
|
||||||
|
|
||||||
|
offset := len(ciphertext) - ctx.authtagBytes
|
||||||
|
expectedTag := ctx.computeAuthTag(data, nonce, ciphertext[:offset])
|
||||||
|
match := subtle.ConstantTimeCompare(expectedTag, ciphertext[offset:])
|
||||||
|
if match != 1 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid ciphertext (auth tag mismatch)")
|
||||||
|
}
|
||||||
|
|
||||||
|
cbc := cipher.NewCBCDecrypter(ctx.blockCipher, nonce)
|
||||||
|
|
||||||
|
// Make copy of ciphertext buffer, don't want to modify in place
|
||||||
|
buffer := append([]byte{}, ciphertext[:offset]...)
|
||||||
|
|
||||||
|
if len(buffer)%ctx.blockCipher.BlockSize() > 0 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid ciphertext (invalid length)")
|
||||||
|
}
|
||||||
|
|
||||||
|
cbc.CryptBlocks(buffer, buffer)
|
||||||
|
|
||||||
|
// Remove padding
|
||||||
|
plaintext, err := unpadBuffer(buffer, ctx.blockCipher.BlockSize())
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
ret, out := resize(dst, uint64(len(dst))+uint64(len(plaintext)))
|
||||||
|
copy(out, plaintext)
|
||||||
|
|
||||||
|
return ret, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compute an authentication tag
|
||||||
|
func (ctx *cbcAEAD) computeAuthTag(aad, nonce, ciphertext []byte) []byte {
|
||||||
|
buffer := make([]byte, uint64(len(aad))+uint64(len(nonce))+uint64(len(ciphertext))+8)
|
||||||
|
n := 0
|
||||||
|
n += copy(buffer, aad)
|
||||||
|
n += copy(buffer[n:], nonce)
|
||||||
|
n += copy(buffer[n:], ciphertext)
|
||||||
|
binary.BigEndian.PutUint64(buffer[n:], uint64(len(aad))*8)
|
||||||
|
|
||||||
|
// According to documentation, Write() on hash.Hash never fails.
|
||||||
|
hmac := hmac.New(ctx.hash, ctx.integrityKey)
|
||||||
|
_, _ = hmac.Write(buffer)
|
||||||
|
|
||||||
|
return hmac.Sum(nil)[:ctx.authtagBytes]
|
||||||
|
}
|
||||||
|
|
||||||
|
// resize ensures that the given slice has a capacity of at least n bytes.
|
||||||
|
// If the capacity of the slice is less than n, a new slice is allocated
|
||||||
|
// and the existing data will be copied.
|
||||||
|
func resize(in []byte, n uint64) (head, tail []byte) {
|
||||||
|
if uint64(cap(in)) >= n {
|
||||||
|
head = in[:n]
|
||||||
|
} else {
|
||||||
|
head = make([]byte, n)
|
||||||
|
copy(head, in)
|
||||||
|
}
|
||||||
|
|
||||||
|
tail = head[len(in):]
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Apply padding
|
||||||
|
func padBuffer(buffer []byte, blockSize int) []byte {
|
||||||
|
missing := blockSize - (len(buffer) % blockSize)
|
||||||
|
ret, out := resize(buffer, uint64(len(buffer))+uint64(missing))
|
||||||
|
padding := bytes.Repeat([]byte{byte(missing)}, missing)
|
||||||
|
copy(out, padding)
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove padding
|
||||||
|
func unpadBuffer(buffer []byte, blockSize int) ([]byte, error) {
|
||||||
|
if len(buffer)%blockSize != 0 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid padding")
|
||||||
|
}
|
||||||
|
|
||||||
|
last := buffer[len(buffer)-1]
|
||||||
|
count := int(last)
|
||||||
|
|
||||||
|
if count == 0 || count > blockSize || count > len(buffer) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid padding")
|
||||||
|
}
|
||||||
|
|
||||||
|
padding := bytes.Repeat([]byte{last}, count)
|
||||||
|
if !bytes.HasSuffix(buffer, padding) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid padding")
|
||||||
|
}
|
||||||
|
|
||||||
|
return buffer[:len(buffer)-count], nil
|
||||||
|
}
|
|
@ -0,0 +1,75 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package josecipher
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto"
|
||||||
|
"encoding/binary"
|
||||||
|
"hash"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
type concatKDF struct {
|
||||||
|
z, info []byte
|
||||||
|
i uint32
|
||||||
|
cache []byte
|
||||||
|
hasher hash.Hash
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewConcatKDF builds a KDF reader based on the given inputs.
|
||||||
|
func NewConcatKDF(hash crypto.Hash, z, algID, ptyUInfo, ptyVInfo, supPubInfo, supPrivInfo []byte) io.Reader {
|
||||||
|
buffer := make([]byte, uint64(len(algID))+uint64(len(ptyUInfo))+uint64(len(ptyVInfo))+uint64(len(supPubInfo))+uint64(len(supPrivInfo)))
|
||||||
|
n := 0
|
||||||
|
n += copy(buffer, algID)
|
||||||
|
n += copy(buffer[n:], ptyUInfo)
|
||||||
|
n += copy(buffer[n:], ptyVInfo)
|
||||||
|
n += copy(buffer[n:], supPubInfo)
|
||||||
|
copy(buffer[n:], supPrivInfo)
|
||||||
|
|
||||||
|
hasher := hash.New()
|
||||||
|
|
||||||
|
return &concatKDF{
|
||||||
|
z: z,
|
||||||
|
info: buffer,
|
||||||
|
hasher: hasher,
|
||||||
|
cache: []byte{},
|
||||||
|
i: 1,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *concatKDF) Read(out []byte) (int, error) {
|
||||||
|
copied := copy(out, ctx.cache)
|
||||||
|
ctx.cache = ctx.cache[copied:]
|
||||||
|
|
||||||
|
for copied < len(out) {
|
||||||
|
ctx.hasher.Reset()
|
||||||
|
|
||||||
|
// Write on a hash.Hash never fails
|
||||||
|
_ = binary.Write(ctx.hasher, binary.BigEndian, ctx.i)
|
||||||
|
_, _ = ctx.hasher.Write(ctx.z)
|
||||||
|
_, _ = ctx.hasher.Write(ctx.info)
|
||||||
|
|
||||||
|
hash := ctx.hasher.Sum(nil)
|
||||||
|
chunkCopied := copy(out[copied:], hash)
|
||||||
|
copied += chunkCopied
|
||||||
|
ctx.cache = hash[chunkCopied:]
|
||||||
|
|
||||||
|
ctx.i++
|
||||||
|
}
|
||||||
|
|
||||||
|
return copied, nil
|
||||||
|
}
|
|
@ -0,0 +1,86 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package josecipher
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"encoding/binary"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DeriveECDHES derives a shared encryption key using ECDH/ConcatKDF as described in JWE/JWA.
|
||||||
|
// It is an error to call this function with a private/public key that are not on the same
|
||||||
|
// curve. Callers must ensure that the keys are valid before calling this function. Output
|
||||||
|
// size may be at most 1<<16 bytes (64 KiB).
|
||||||
|
func DeriveECDHES(alg string, apuData, apvData []byte, priv *ecdsa.PrivateKey, pub *ecdsa.PublicKey, size int) []byte {
|
||||||
|
if size > 1<<16 {
|
||||||
|
panic("ECDH-ES output size too large, must be less than or equal to 1<<16")
|
||||||
|
}
|
||||||
|
|
||||||
|
// algId, partyUInfo, partyVInfo inputs must be prefixed with the length
|
||||||
|
algID := lengthPrefixed([]byte(alg))
|
||||||
|
ptyUInfo := lengthPrefixed(apuData)
|
||||||
|
ptyVInfo := lengthPrefixed(apvData)
|
||||||
|
|
||||||
|
// suppPubInfo is the encoded length of the output size in bits
|
||||||
|
supPubInfo := make([]byte, 4)
|
||||||
|
binary.BigEndian.PutUint32(supPubInfo, uint32(size)*8)
|
||||||
|
|
||||||
|
if !priv.PublicKey.Curve.IsOnCurve(pub.X, pub.Y) {
|
||||||
|
panic("public key not on same curve as private key")
|
||||||
|
}
|
||||||
|
|
||||||
|
z, _ := priv.Curve.ScalarMult(pub.X, pub.Y, priv.D.Bytes())
|
||||||
|
zBytes := z.Bytes()
|
||||||
|
|
||||||
|
// Note that calling z.Bytes() on a big.Int may strip leading zero bytes from
|
||||||
|
// the returned byte array. This can lead to a problem where zBytes will be
|
||||||
|
// shorter than expected which breaks the key derivation. Therefore we must pad
|
||||||
|
// to the full length of the expected coordinate here before calling the KDF.
|
||||||
|
octSize := dSize(priv.Curve)
|
||||||
|
if len(zBytes) != octSize {
|
||||||
|
zBytes = append(bytes.Repeat([]byte{0}, octSize-len(zBytes)), zBytes...)
|
||||||
|
}
|
||||||
|
|
||||||
|
reader := NewConcatKDF(crypto.SHA256, zBytes, algID, ptyUInfo, ptyVInfo, supPubInfo, []byte{})
|
||||||
|
key := make([]byte, size)
|
||||||
|
|
||||||
|
// Read on the KDF will never fail
|
||||||
|
_, _ = reader.Read(key)
|
||||||
|
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
|
||||||
|
// dSize returns the size in octets for a coordinate on a elliptic curve.
|
||||||
|
func dSize(curve elliptic.Curve) int {
|
||||||
|
order := curve.Params().P
|
||||||
|
bitLen := order.BitLen()
|
||||||
|
size := bitLen / 8
|
||||||
|
if bitLen%8 != 0 {
|
||||||
|
size++
|
||||||
|
}
|
||||||
|
return size
|
||||||
|
}
|
||||||
|
|
||||||
|
func lengthPrefixed(data []byte) []byte {
|
||||||
|
out := make([]byte, len(data)+4)
|
||||||
|
binary.BigEndian.PutUint32(out, uint32(len(data)))
|
||||||
|
copy(out[4:], data)
|
||||||
|
return out
|
||||||
|
}
|
|
@ -0,0 +1,109 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package josecipher
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/cipher"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/binary"
|
||||||
|
"errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
var defaultIV = []byte{0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6}
|
||||||
|
|
||||||
|
// KeyWrap implements NIST key wrapping; it wraps a content encryption key (cek) with the given block cipher.
|
||||||
|
func KeyWrap(block cipher.Block, cek []byte) ([]byte, error) {
|
||||||
|
if len(cek)%8 != 0 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: key wrap input must be 8 byte blocks")
|
||||||
|
}
|
||||||
|
|
||||||
|
n := len(cek) / 8
|
||||||
|
r := make([][]byte, n)
|
||||||
|
|
||||||
|
for i := range r {
|
||||||
|
r[i] = make([]byte, 8)
|
||||||
|
copy(r[i], cek[i*8:])
|
||||||
|
}
|
||||||
|
|
||||||
|
buffer := make([]byte, 16)
|
||||||
|
tBytes := make([]byte, 8)
|
||||||
|
copy(buffer, defaultIV)
|
||||||
|
|
||||||
|
for t := 0; t < 6*n; t++ {
|
||||||
|
copy(buffer[8:], r[t%n])
|
||||||
|
|
||||||
|
block.Encrypt(buffer, buffer)
|
||||||
|
|
||||||
|
binary.BigEndian.PutUint64(tBytes, uint64(t+1))
|
||||||
|
|
||||||
|
for i := 0; i < 8; i++ {
|
||||||
|
buffer[i] ^= tBytes[i]
|
||||||
|
}
|
||||||
|
copy(r[t%n], buffer[8:])
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]byte, (n+1)*8)
|
||||||
|
copy(out, buffer[:8])
|
||||||
|
for i := range r {
|
||||||
|
copy(out[(i+1)*8:], r[i])
|
||||||
|
}
|
||||||
|
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyUnwrap implements NIST key unwrapping; it unwraps a content encryption key (cek) with the given block cipher.
|
||||||
|
func KeyUnwrap(block cipher.Block, ciphertext []byte) ([]byte, error) {
|
||||||
|
if len(ciphertext)%8 != 0 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: key wrap input must be 8 byte blocks")
|
||||||
|
}
|
||||||
|
|
||||||
|
n := (len(ciphertext) / 8) - 1
|
||||||
|
r := make([][]byte, n)
|
||||||
|
|
||||||
|
for i := range r {
|
||||||
|
r[i] = make([]byte, 8)
|
||||||
|
copy(r[i], ciphertext[(i+1)*8:])
|
||||||
|
}
|
||||||
|
|
||||||
|
buffer := make([]byte, 16)
|
||||||
|
tBytes := make([]byte, 8)
|
||||||
|
copy(buffer[:8], ciphertext[:8])
|
||||||
|
|
||||||
|
for t := 6*n - 1; t >= 0; t-- {
|
||||||
|
binary.BigEndian.PutUint64(tBytes, uint64(t+1))
|
||||||
|
|
||||||
|
for i := 0; i < 8; i++ {
|
||||||
|
buffer[i] ^= tBytes[i]
|
||||||
|
}
|
||||||
|
copy(buffer[8:], r[t%n])
|
||||||
|
|
||||||
|
block.Decrypt(buffer, buffer)
|
||||||
|
|
||||||
|
copy(r[t%n], buffer[8:])
|
||||||
|
}
|
||||||
|
|
||||||
|
if subtle.ConstantTimeCompare(buffer[:8], defaultIV) == 0 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: failed to unwrap key")
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]byte, n*8)
|
||||||
|
for i := range r {
|
||||||
|
copy(out[i*8:], r[i])
|
||||||
|
}
|
||||||
|
|
||||||
|
return out, nil
|
||||||
|
}
|
|
@ -0,0 +1,593 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/rsa"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Encrypter represents an encrypter which produces an encrypted JWE object.
|
||||||
|
type Encrypter interface {
|
||||||
|
Encrypt(plaintext []byte) (*JSONWebEncryption, error)
|
||||||
|
EncryptWithAuthData(plaintext []byte, aad []byte) (*JSONWebEncryption, error)
|
||||||
|
Options() EncrypterOptions
|
||||||
|
}
|
||||||
|
|
||||||
|
// A generic content cipher
|
||||||
|
type contentCipher interface {
|
||||||
|
keySize() int
|
||||||
|
encrypt(cek []byte, aad, plaintext []byte) (*aeadParts, error)
|
||||||
|
decrypt(cek []byte, aad []byte, parts *aeadParts) ([]byte, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A key generator (for generating/getting a CEK)
|
||||||
|
type keyGenerator interface {
|
||||||
|
keySize() int
|
||||||
|
genKey() ([]byte, rawHeader, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A generic key encrypter
|
||||||
|
type keyEncrypter interface {
|
||||||
|
encryptKey(cek []byte, alg KeyAlgorithm) (recipientInfo, error) // Encrypt a key
|
||||||
|
}
|
||||||
|
|
||||||
|
// A generic key decrypter
|
||||||
|
type keyDecrypter interface {
|
||||||
|
decryptKey(headers rawHeader, recipient *recipientInfo, generator keyGenerator) ([]byte, error) // Decrypt a key
|
||||||
|
}
|
||||||
|
|
||||||
|
// A generic encrypter based on the given key encrypter and content cipher.
|
||||||
|
type genericEncrypter struct {
|
||||||
|
contentAlg ContentEncryption
|
||||||
|
compressionAlg CompressionAlgorithm
|
||||||
|
cipher contentCipher
|
||||||
|
recipients []recipientKeyInfo
|
||||||
|
keyGenerator keyGenerator
|
||||||
|
extraHeaders map[HeaderKey]interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
type recipientKeyInfo struct {
|
||||||
|
keyID string
|
||||||
|
keyAlg KeyAlgorithm
|
||||||
|
keyEncrypter keyEncrypter
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncrypterOptions represents options that can be set on new encrypters.
|
||||||
|
type EncrypterOptions struct {
|
||||||
|
Compression CompressionAlgorithm
|
||||||
|
|
||||||
|
// Optional map of name/value pairs to be inserted into the protected
|
||||||
|
// header of a JWS object. Some specifications which make use of
|
||||||
|
// JWS require additional values here.
|
||||||
|
//
|
||||||
|
// Values will be serialized by [json.Marshal] and must be valid inputs to
|
||||||
|
// that function.
|
||||||
|
//
|
||||||
|
// [json.Marshal]: https://pkg.go.dev/encoding/json#Marshal
|
||||||
|
ExtraHeaders map[HeaderKey]interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithHeader adds an arbitrary value to the ExtraHeaders map, initializing it
|
||||||
|
// if necessary, and returns the updated EncrypterOptions.
|
||||||
|
//
|
||||||
|
// The v parameter will be serialized by [json.Marshal] and must be a valid
|
||||||
|
// input to that function.
|
||||||
|
//
|
||||||
|
// [json.Marshal]: https://pkg.go.dev/encoding/json#Marshal
|
||||||
|
func (eo *EncrypterOptions) WithHeader(k HeaderKey, v interface{}) *EncrypterOptions {
|
||||||
|
if eo.ExtraHeaders == nil {
|
||||||
|
eo.ExtraHeaders = map[HeaderKey]interface{}{}
|
||||||
|
}
|
||||||
|
eo.ExtraHeaders[k] = v
|
||||||
|
return eo
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithContentType adds a content type ("cty") header and returns the updated
|
||||||
|
// EncrypterOptions.
|
||||||
|
func (eo *EncrypterOptions) WithContentType(contentType ContentType) *EncrypterOptions {
|
||||||
|
return eo.WithHeader(HeaderContentType, contentType)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithType adds a type ("typ") header and returns the updated EncrypterOptions.
|
||||||
|
func (eo *EncrypterOptions) WithType(typ ContentType) *EncrypterOptions {
|
||||||
|
return eo.WithHeader(HeaderType, typ)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Recipient represents an algorithm/key to encrypt messages to.
|
||||||
|
//
|
||||||
|
// PBES2Count and PBES2Salt correspond with the "p2c" and "p2s" headers used
|
||||||
|
// on the password-based encryption algorithms PBES2-HS256+A128KW,
|
||||||
|
// PBES2-HS384+A192KW, and PBES2-HS512+A256KW. If they are not provided a safe
|
||||||
|
// default of 100000 will be used for the count and a 128-bit random salt will
|
||||||
|
// be generated.
|
||||||
|
type Recipient struct {
|
||||||
|
Algorithm KeyAlgorithm
|
||||||
|
// Key must have one of these types:
|
||||||
|
// - ed25519.PublicKey
|
||||||
|
// - *ecdsa.PublicKey
|
||||||
|
// - *rsa.PublicKey
|
||||||
|
// - *JSONWebKey
|
||||||
|
// - JSONWebKey
|
||||||
|
// - []byte (a symmetric key)
|
||||||
|
// - Any type that satisfies the OpaqueKeyEncrypter interface
|
||||||
|
//
|
||||||
|
// The type of Key must match the value of Algorithm.
|
||||||
|
Key interface{}
|
||||||
|
KeyID string
|
||||||
|
PBES2Count int
|
||||||
|
PBES2Salt []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewEncrypter creates an appropriate encrypter based on the key type
|
||||||
|
func NewEncrypter(enc ContentEncryption, rcpt Recipient, opts *EncrypterOptions) (Encrypter, error) {
|
||||||
|
encrypter := &genericEncrypter{
|
||||||
|
contentAlg: enc,
|
||||||
|
recipients: []recipientKeyInfo{},
|
||||||
|
cipher: getContentCipher(enc),
|
||||||
|
}
|
||||||
|
if opts != nil {
|
||||||
|
encrypter.compressionAlg = opts.Compression
|
||||||
|
encrypter.extraHeaders = opts.ExtraHeaders
|
||||||
|
}
|
||||||
|
|
||||||
|
if encrypter.cipher == nil {
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
var keyID string
|
||||||
|
var rawKey interface{}
|
||||||
|
switch encryptionKey := rcpt.Key.(type) {
|
||||||
|
case JSONWebKey:
|
||||||
|
keyID, rawKey = encryptionKey.KeyID, encryptionKey.Key
|
||||||
|
case *JSONWebKey:
|
||||||
|
keyID, rawKey = encryptionKey.KeyID, encryptionKey.Key
|
||||||
|
case OpaqueKeyEncrypter:
|
||||||
|
keyID, rawKey = encryptionKey.KeyID(), encryptionKey
|
||||||
|
default:
|
||||||
|
rawKey = encryptionKey
|
||||||
|
}
|
||||||
|
|
||||||
|
switch rcpt.Algorithm {
|
||||||
|
case DIRECT:
|
||||||
|
// Direct encryption mode must be treated differently
|
||||||
|
keyBytes, ok := rawKey.([]byte)
|
||||||
|
if !ok {
|
||||||
|
return nil, ErrUnsupportedKeyType
|
||||||
|
}
|
||||||
|
if encrypter.cipher.keySize() != len(keyBytes) {
|
||||||
|
return nil, ErrInvalidKeySize
|
||||||
|
}
|
||||||
|
encrypter.keyGenerator = staticKeyGenerator{
|
||||||
|
key: keyBytes,
|
||||||
|
}
|
||||||
|
recipientInfo, _ := newSymmetricRecipient(rcpt.Algorithm, keyBytes)
|
||||||
|
recipientInfo.keyID = keyID
|
||||||
|
if rcpt.KeyID != "" {
|
||||||
|
recipientInfo.keyID = rcpt.KeyID
|
||||||
|
}
|
||||||
|
encrypter.recipients = []recipientKeyInfo{recipientInfo}
|
||||||
|
return encrypter, nil
|
||||||
|
case ECDH_ES:
|
||||||
|
// ECDH-ES (w/o key wrapping) is similar to DIRECT mode
|
||||||
|
keyDSA, ok := rawKey.(*ecdsa.PublicKey)
|
||||||
|
if !ok {
|
||||||
|
return nil, ErrUnsupportedKeyType
|
||||||
|
}
|
||||||
|
encrypter.keyGenerator = ecKeyGenerator{
|
||||||
|
size: encrypter.cipher.keySize(),
|
||||||
|
algID: string(enc),
|
||||||
|
publicKey: keyDSA,
|
||||||
|
}
|
||||||
|
recipientInfo, _ := newECDHRecipient(rcpt.Algorithm, keyDSA)
|
||||||
|
recipientInfo.keyID = keyID
|
||||||
|
if rcpt.KeyID != "" {
|
||||||
|
recipientInfo.keyID = rcpt.KeyID
|
||||||
|
}
|
||||||
|
encrypter.recipients = []recipientKeyInfo{recipientInfo}
|
||||||
|
return encrypter, nil
|
||||||
|
default:
|
||||||
|
// Can just add a standard recipient
|
||||||
|
encrypter.keyGenerator = randomKeyGenerator{
|
||||||
|
size: encrypter.cipher.keySize(),
|
||||||
|
}
|
||||||
|
err := encrypter.addRecipient(rcpt)
|
||||||
|
return encrypter, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewMultiEncrypter creates a multi-encrypter based on the given parameters
|
||||||
|
func NewMultiEncrypter(enc ContentEncryption, rcpts []Recipient, opts *EncrypterOptions) (Encrypter, error) {
|
||||||
|
cipher := getContentCipher(enc)
|
||||||
|
|
||||||
|
if cipher == nil {
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
if len(rcpts) == 0 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: recipients is nil or empty")
|
||||||
|
}
|
||||||
|
|
||||||
|
encrypter := &genericEncrypter{
|
||||||
|
contentAlg: enc,
|
||||||
|
recipients: []recipientKeyInfo{},
|
||||||
|
cipher: cipher,
|
||||||
|
keyGenerator: randomKeyGenerator{
|
||||||
|
size: cipher.keySize(),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
if opts != nil {
|
||||||
|
encrypter.compressionAlg = opts.Compression
|
||||||
|
encrypter.extraHeaders = opts.ExtraHeaders
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, recipient := range rcpts {
|
||||||
|
err := encrypter.addRecipient(recipient)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return encrypter, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *genericEncrypter) addRecipient(recipient Recipient) (err error) {
|
||||||
|
var recipientInfo recipientKeyInfo
|
||||||
|
|
||||||
|
switch recipient.Algorithm {
|
||||||
|
case DIRECT, ECDH_ES:
|
||||||
|
return fmt.Errorf("go-jose/go-jose: key algorithm '%s' not supported in multi-recipient mode", recipient.Algorithm)
|
||||||
|
}
|
||||||
|
|
||||||
|
recipientInfo, err = makeJWERecipient(recipient.Algorithm, recipient.Key)
|
||||||
|
if recipient.KeyID != "" {
|
||||||
|
recipientInfo.keyID = recipient.KeyID
|
||||||
|
}
|
||||||
|
|
||||||
|
switch recipient.Algorithm {
|
||||||
|
case PBES2_HS256_A128KW, PBES2_HS384_A192KW, PBES2_HS512_A256KW:
|
||||||
|
if sr, ok := recipientInfo.keyEncrypter.(*symmetricKeyCipher); ok {
|
||||||
|
sr.p2c = recipient.PBES2Count
|
||||||
|
sr.p2s = recipient.PBES2Salt
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if err == nil {
|
||||||
|
ctx.recipients = append(ctx.recipients, recipientInfo)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeJWERecipient(alg KeyAlgorithm, encryptionKey interface{}) (recipientKeyInfo, error) {
|
||||||
|
switch encryptionKey := encryptionKey.(type) {
|
||||||
|
case *rsa.PublicKey:
|
||||||
|
return newRSARecipient(alg, encryptionKey)
|
||||||
|
case *ecdsa.PublicKey:
|
||||||
|
return newECDHRecipient(alg, encryptionKey)
|
||||||
|
case []byte:
|
||||||
|
return newSymmetricRecipient(alg, encryptionKey)
|
||||||
|
case string:
|
||||||
|
return newSymmetricRecipient(alg, []byte(encryptionKey))
|
||||||
|
case *JSONWebKey:
|
||||||
|
recipient, err := makeJWERecipient(alg, encryptionKey.Key)
|
||||||
|
recipient.keyID = encryptionKey.KeyID
|
||||||
|
return recipient, err
|
||||||
|
case OpaqueKeyEncrypter:
|
||||||
|
return newOpaqueKeyEncrypter(alg, encryptionKey)
|
||||||
|
}
|
||||||
|
return recipientKeyInfo{}, ErrUnsupportedKeyType
|
||||||
|
}
|
||||||
|
|
||||||
|
// newDecrypter creates an appropriate decrypter based on the key type
|
||||||
|
func newDecrypter(decryptionKey interface{}) (keyDecrypter, error) {
|
||||||
|
switch decryptionKey := decryptionKey.(type) {
|
||||||
|
case *rsa.PrivateKey:
|
||||||
|
return &rsaDecrypterSigner{
|
||||||
|
privateKey: decryptionKey,
|
||||||
|
}, nil
|
||||||
|
case *ecdsa.PrivateKey:
|
||||||
|
return &ecDecrypterSigner{
|
||||||
|
privateKey: decryptionKey,
|
||||||
|
}, nil
|
||||||
|
case []byte:
|
||||||
|
return &symmetricKeyCipher{
|
||||||
|
key: decryptionKey,
|
||||||
|
}, nil
|
||||||
|
case string:
|
||||||
|
return &symmetricKeyCipher{
|
||||||
|
key: []byte(decryptionKey),
|
||||||
|
}, nil
|
||||||
|
case JSONWebKey:
|
||||||
|
return newDecrypter(decryptionKey.Key)
|
||||||
|
case *JSONWebKey:
|
||||||
|
return newDecrypter(decryptionKey.Key)
|
||||||
|
case OpaqueKeyDecrypter:
|
||||||
|
return &opaqueKeyDecrypter{decrypter: decryptionKey}, nil
|
||||||
|
default:
|
||||||
|
return nil, ErrUnsupportedKeyType
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Implementation of encrypt method producing a JWE object.
|
||||||
|
func (ctx *genericEncrypter) Encrypt(plaintext []byte) (*JSONWebEncryption, error) {
|
||||||
|
return ctx.EncryptWithAuthData(plaintext, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Implementation of encrypt method producing a JWE object.
|
||||||
|
func (ctx *genericEncrypter) EncryptWithAuthData(plaintext, aad []byte) (*JSONWebEncryption, error) {
|
||||||
|
obj := &JSONWebEncryption{}
|
||||||
|
obj.aad = aad
|
||||||
|
|
||||||
|
obj.protected = &rawHeader{}
|
||||||
|
err := obj.protected.set(headerEncryption, ctx.contentAlg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
obj.recipients = make([]recipientInfo, len(ctx.recipients))
|
||||||
|
|
||||||
|
if len(ctx.recipients) == 0 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: no recipients to encrypt to")
|
||||||
|
}
|
||||||
|
|
||||||
|
cek, headers, err := ctx.keyGenerator.genKey()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
obj.protected.merge(&headers)
|
||||||
|
|
||||||
|
for i, info := range ctx.recipients {
|
||||||
|
recipient, err := info.keyEncrypter.encryptKey(cek, info.keyAlg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = recipient.header.set(headerAlgorithm, info.keyAlg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if info.keyID != "" {
|
||||||
|
err = recipient.header.set(headerKeyID, info.keyID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
obj.recipients[i] = recipient
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(ctx.recipients) == 1 {
|
||||||
|
// Move per-recipient headers into main protected header if there's
|
||||||
|
// only a single recipient.
|
||||||
|
obj.protected.merge(obj.recipients[0].header)
|
||||||
|
obj.recipients[0].header = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.compressionAlg != NONE {
|
||||||
|
plaintext, err = compress(ctx.compressionAlg, plaintext)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = obj.protected.set(headerCompression, ctx.compressionAlg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range ctx.extraHeaders {
|
||||||
|
b, err := json.Marshal(v)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
(*obj.protected)[k] = makeRawMessage(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
authData := obj.computeAuthData()
|
||||||
|
parts, err := ctx.cipher.encrypt(cek, authData, plaintext)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
obj.iv = parts.iv
|
||||||
|
obj.ciphertext = parts.ciphertext
|
||||||
|
obj.tag = parts.tag
|
||||||
|
|
||||||
|
return obj, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *genericEncrypter) Options() EncrypterOptions {
|
||||||
|
return EncrypterOptions{
|
||||||
|
Compression: ctx.compressionAlg,
|
||||||
|
ExtraHeaders: ctx.extraHeaders,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt and validate the object and return the plaintext. This
|
||||||
|
// function does not support multi-recipient. If you desire multi-recipient
|
||||||
|
// decryption use DecryptMulti instead.
|
||||||
|
//
|
||||||
|
// The decryptionKey argument must contain a private or symmetric key
|
||||||
|
// and must have one of these types:
|
||||||
|
// - *ecdsa.PrivateKey
|
||||||
|
// - *rsa.PrivateKey
|
||||||
|
// - *JSONWebKey
|
||||||
|
// - JSONWebKey
|
||||||
|
// - *JSONWebKeySet
|
||||||
|
// - JSONWebKeySet
|
||||||
|
// - []byte (a symmetric key)
|
||||||
|
// - string (a symmetric key)
|
||||||
|
// - Any type that satisfies the OpaqueKeyDecrypter interface.
|
||||||
|
//
|
||||||
|
// Note that ed25519 is only available for signatures, not encryption, so is
|
||||||
|
// not an option here.
|
||||||
|
//
|
||||||
|
// Automatically decompresses plaintext, but returns an error if the decompressed
|
||||||
|
// data would be >250kB or >10x the size of the compressed data, whichever is larger.
|
||||||
|
func (obj JSONWebEncryption) Decrypt(decryptionKey interface{}) ([]byte, error) {
|
||||||
|
headers := obj.mergedHeaders(nil)
|
||||||
|
|
||||||
|
if len(obj.recipients) > 1 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: too many recipients in payload; expecting only one")
|
||||||
|
}
|
||||||
|
|
||||||
|
critical, err := headers.getCritical()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid crit header")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(critical) > 0 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: unsupported crit header")
|
||||||
|
}
|
||||||
|
|
||||||
|
key := tryJWKS(decryptionKey, obj.Header)
|
||||||
|
decrypter, err := newDecrypter(key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
cipher := getContentCipher(headers.getEncryption())
|
||||||
|
if cipher == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: unsupported enc value '%s'", string(headers.getEncryption()))
|
||||||
|
}
|
||||||
|
|
||||||
|
generator := randomKeyGenerator{
|
||||||
|
size: cipher.keySize(),
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := &aeadParts{
|
||||||
|
iv: obj.iv,
|
||||||
|
ciphertext: obj.ciphertext,
|
||||||
|
tag: obj.tag,
|
||||||
|
}
|
||||||
|
|
||||||
|
authData := obj.computeAuthData()
|
||||||
|
|
||||||
|
var plaintext []byte
|
||||||
|
recipient := obj.recipients[0]
|
||||||
|
recipientHeaders := obj.mergedHeaders(&recipient)
|
||||||
|
|
||||||
|
cek, err := decrypter.decryptKey(recipientHeaders, &recipient, generator)
|
||||||
|
if err == nil {
|
||||||
|
// Found a valid CEK -- let's try to decrypt.
|
||||||
|
plaintext, err = cipher.decrypt(cek, authData, parts)
|
||||||
|
}
|
||||||
|
|
||||||
|
if plaintext == nil {
|
||||||
|
return nil, ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
// The "zip" header parameter may only be present in the protected header.
|
||||||
|
if comp := obj.protected.getCompression(); comp != "" {
|
||||||
|
plaintext, err = decompress(comp, plaintext)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: failed to decompress plaintext: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return plaintext, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecryptMulti decrypts and validates the object and returns the plaintexts,
|
||||||
|
// with support for multiple recipients. It returns the index of the recipient
|
||||||
|
// for which the decryption was successful, the merged headers for that recipient,
|
||||||
|
// and the plaintext.
|
||||||
|
//
|
||||||
|
// The decryptionKey argument must have one of the types allowed for the
|
||||||
|
// decryptionKey argument of Decrypt().
|
||||||
|
//
|
||||||
|
// Automatically decompresses plaintext, but returns an error if the decompressed
|
||||||
|
// data would be >250kB or >3x the size of the compressed data, whichever is larger.
|
||||||
|
func (obj JSONWebEncryption) DecryptMulti(decryptionKey interface{}) (int, Header, []byte, error) {
|
||||||
|
globalHeaders := obj.mergedHeaders(nil)
|
||||||
|
|
||||||
|
critical, err := globalHeaders.getCritical()
|
||||||
|
if err != nil {
|
||||||
|
return -1, Header{}, nil, fmt.Errorf("go-jose/go-jose: invalid crit header")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(critical) > 0 {
|
||||||
|
return -1, Header{}, nil, fmt.Errorf("go-jose/go-jose: unsupported crit header")
|
||||||
|
}
|
||||||
|
|
||||||
|
key := tryJWKS(decryptionKey, obj.Header)
|
||||||
|
decrypter, err := newDecrypter(key)
|
||||||
|
if err != nil {
|
||||||
|
return -1, Header{}, nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
encryption := globalHeaders.getEncryption()
|
||||||
|
cipher := getContentCipher(encryption)
|
||||||
|
if cipher == nil {
|
||||||
|
return -1, Header{}, nil, fmt.Errorf("go-jose/go-jose: unsupported enc value '%s'", string(encryption))
|
||||||
|
}
|
||||||
|
|
||||||
|
generator := randomKeyGenerator{
|
||||||
|
size: cipher.keySize(),
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := &aeadParts{
|
||||||
|
iv: obj.iv,
|
||||||
|
ciphertext: obj.ciphertext,
|
||||||
|
tag: obj.tag,
|
||||||
|
}
|
||||||
|
|
||||||
|
authData := obj.computeAuthData()
|
||||||
|
|
||||||
|
index := -1
|
||||||
|
var plaintext []byte
|
||||||
|
var headers rawHeader
|
||||||
|
|
||||||
|
for i, recipient := range obj.recipients {
|
||||||
|
recipientHeaders := obj.mergedHeaders(&recipient)
|
||||||
|
|
||||||
|
cek, err := decrypter.decryptKey(recipientHeaders, &recipient, generator)
|
||||||
|
if err == nil {
|
||||||
|
// Found a valid CEK -- let's try to decrypt.
|
||||||
|
plaintext, err = cipher.decrypt(cek, authData, parts)
|
||||||
|
if err == nil {
|
||||||
|
index = i
|
||||||
|
headers = recipientHeaders
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if plaintext == nil {
|
||||||
|
return -1, Header{}, nil, ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
// The "zip" header parameter may only be present in the protected header.
|
||||||
|
if comp := obj.protected.getCompression(); comp != "" {
|
||||||
|
plaintext, err = decompress(comp, plaintext)
|
||||||
|
if err != nil {
|
||||||
|
return -1, Header{}, nil, fmt.Errorf("go-jose/go-jose: failed to decompress plaintext: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sanitized, err := headers.sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return -1, Header{}, nil, fmt.Errorf("go-jose/go-jose: failed to sanitize header: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return index, sanitized, plaintext, err
|
||||||
|
}
|
|
@ -0,0 +1,25 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
Package jose aims to provide an implementation of the Javascript Object Signing
|
||||||
|
and Encryption set of standards. It implements encryption and signing based on
|
||||||
|
the JSON Web Encryption and JSON Web Signature standards, with optional JSON Web
|
||||||
|
Token support available in a sub-package. The library supports both the compact
|
||||||
|
and JWS/JWE JSON Serialization formats, and has optional support for multiple
|
||||||
|
recipients.
|
||||||
|
*/
|
||||||
|
package jose
|
|
@ -0,0 +1,237 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"compress/flate"
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/binary"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"math/big"
|
||||||
|
"strings"
|
||||||
|
"unicode"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Helper function to serialize known-good objects.
|
||||||
|
// Precondition: value is not a nil pointer.
|
||||||
|
func mustSerializeJSON(value interface{}) []byte {
|
||||||
|
out, err := json.Marshal(value)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
// We never want to serialize the top-level value "null," since it's not a
|
||||||
|
// valid JOSE message. But if a caller passes in a nil pointer to this method,
|
||||||
|
// MarshalJSON will happily serialize it as the top-level value "null". If
|
||||||
|
// that value is then embedded in another operation, for instance by being
|
||||||
|
// base64-encoded and fed as input to a signing algorithm
|
||||||
|
// (https://github.com/go-jose/go-jose/issues/22), the result will be
|
||||||
|
// incorrect. Because this method is intended for known-good objects, and a nil
|
||||||
|
// pointer is not a known-good object, we are free to panic in this case.
|
||||||
|
// Note: It's not possible to directly check whether the data pointed at by an
|
||||||
|
// interface is a nil pointer, so we do this hacky workaround.
|
||||||
|
// https://groups.google.com/forum/#!topic/golang-nuts/wnH302gBa4I
|
||||||
|
if string(out) == "null" {
|
||||||
|
panic("Tried to serialize a nil pointer.")
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Strip all newlines and whitespace
|
||||||
|
func stripWhitespace(data string) string {
|
||||||
|
buf := strings.Builder{}
|
||||||
|
buf.Grow(len(data))
|
||||||
|
for _, r := range data {
|
||||||
|
if !unicode.IsSpace(r) {
|
||||||
|
buf.WriteRune(r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Perform compression based on algorithm
|
||||||
|
func compress(algorithm CompressionAlgorithm, input []byte) ([]byte, error) {
|
||||||
|
switch algorithm {
|
||||||
|
case DEFLATE:
|
||||||
|
return deflate(input)
|
||||||
|
default:
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Perform decompression based on algorithm
|
||||||
|
func decompress(algorithm CompressionAlgorithm, input []byte) ([]byte, error) {
|
||||||
|
switch algorithm {
|
||||||
|
case DEFLATE:
|
||||||
|
return inflate(input)
|
||||||
|
default:
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// deflate compresses the input.
|
||||||
|
func deflate(input []byte) ([]byte, error) {
|
||||||
|
output := new(bytes.Buffer)
|
||||||
|
|
||||||
|
// Writing to byte buffer, err is always nil
|
||||||
|
writer, _ := flate.NewWriter(output, 1)
|
||||||
|
_, _ = io.Copy(writer, bytes.NewBuffer(input))
|
||||||
|
|
||||||
|
err := writer.Close()
|
||||||
|
return output.Bytes(), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// inflate decompresses the input.
|
||||||
|
//
|
||||||
|
// Errors if the decompressed data would be >250kB or >10x the size of the
|
||||||
|
// compressed data, whichever is larger.
|
||||||
|
func inflate(input []byte) ([]byte, error) {
|
||||||
|
output := new(bytes.Buffer)
|
||||||
|
reader := flate.NewReader(bytes.NewBuffer(input))
|
||||||
|
|
||||||
|
maxCompressedSize := 10 * int64(len(input))
|
||||||
|
if maxCompressedSize < 250000 {
|
||||||
|
maxCompressedSize = 250000
|
||||||
|
}
|
||||||
|
|
||||||
|
limit := maxCompressedSize + 1
|
||||||
|
n, err := io.CopyN(output, reader, limit)
|
||||||
|
if err != nil && err != io.EOF {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if n == limit {
|
||||||
|
return nil, fmt.Errorf("uncompressed data would be too large (>%d bytes)", maxCompressedSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = reader.Close()
|
||||||
|
return output.Bytes(), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// byteBuffer represents a slice of bytes that can be serialized to url-safe base64.
|
||||||
|
type byteBuffer struct {
|
||||||
|
data []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
func newBuffer(data []byte) *byteBuffer {
|
||||||
|
if data == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &byteBuffer{
|
||||||
|
data: data,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFixedSizeBuffer(data []byte, length int) *byteBuffer {
|
||||||
|
if len(data) > length {
|
||||||
|
panic("go-jose/go-jose: invalid call to newFixedSizeBuffer (len(data) > length)")
|
||||||
|
}
|
||||||
|
pad := make([]byte, length-len(data))
|
||||||
|
return newBuffer(append(pad, data...))
|
||||||
|
}
|
||||||
|
|
||||||
|
func newBufferFromInt(num uint64) *byteBuffer {
|
||||||
|
data := make([]byte, 8)
|
||||||
|
binary.BigEndian.PutUint64(data, num)
|
||||||
|
return newBuffer(bytes.TrimLeft(data, "\x00"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *byteBuffer) MarshalJSON() ([]byte, error) {
|
||||||
|
return json.Marshal(b.base64())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *byteBuffer) UnmarshalJSON(data []byte) error {
|
||||||
|
var encoded string
|
||||||
|
err := json.Unmarshal(data, &encoded)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if encoded == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
decoded, err := base64URLDecode(encoded)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
*b = *newBuffer(decoded)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *byteBuffer) base64() string {
|
||||||
|
return base64.RawURLEncoding.EncodeToString(b.data)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *byteBuffer) bytes() []byte {
|
||||||
|
// Handling nil here allows us to transparently handle nil slices when serializing.
|
||||||
|
if b == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return b.data
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b byteBuffer) bigInt() *big.Int {
|
||||||
|
return new(big.Int).SetBytes(b.data)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b byteBuffer) toInt() int {
|
||||||
|
return int(b.bigInt().Int64())
|
||||||
|
}
|
||||||
|
|
||||||
|
// base64URLDecode is implemented as defined in https://www.rfc-editor.org/rfc/rfc7515.html#appendix-C
|
||||||
|
func base64URLDecode(value string) ([]byte, error) {
|
||||||
|
value = strings.TrimRight(value, "=")
|
||||||
|
return base64.RawURLEncoding.DecodeString(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
func base64EncodeLen(sl []byte) int {
|
||||||
|
return base64.RawURLEncoding.EncodedLen(len(sl))
|
||||||
|
}
|
||||||
|
|
||||||
|
func base64JoinWithDots(inputs ...[]byte) string {
|
||||||
|
if len(inputs) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// Count of dots.
|
||||||
|
totalCount := len(inputs) - 1
|
||||||
|
|
||||||
|
for _, input := range inputs {
|
||||||
|
totalCount += base64EncodeLen(input)
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]byte, totalCount)
|
||||||
|
startEncode := 0
|
||||||
|
for i, input := range inputs {
|
||||||
|
base64.RawURLEncoding.Encode(out[startEncode:], input)
|
||||||
|
|
||||||
|
if i == len(inputs)-1 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
startEncode += base64EncodeLen(input)
|
||||||
|
out[startEncode] = '.'
|
||||||
|
startEncode++
|
||||||
|
}
|
||||||
|
|
||||||
|
return string(out)
|
||||||
|
}
|
|
@ -0,0 +1,27 @@
|
||||||
|
Copyright (c) 2012 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of Google Inc. nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Safe JSON
|
||||||
|
|
||||||
|
This repository contains a fork of the `encoding/json` package from Go 1.6.
|
||||||
|
|
||||||
|
The following changes were made:
|
||||||
|
|
||||||
|
* Object deserialization uses case-sensitive member name matching instead of
|
||||||
|
[case-insensitive matching](https://www.ietf.org/mail-archive/web/json/current/msg03763.html).
|
||||||
|
This is to avoid differences in the interpretation of JOSE messages between
|
||||||
|
go-jose and libraries written in other languages.
|
||||||
|
* When deserializing a JSON object, we check for duplicate keys and reject the
|
||||||
|
input whenever we detect a duplicate. Rather than trying to work with malformed
|
||||||
|
data, we prefer to reject it right away.
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,141 @@
|
||||||
|
// Copyright 2010 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package json
|
||||||
|
|
||||||
|
import "bytes"
|
||||||
|
|
||||||
|
// Compact appends to dst the JSON-encoded src with
|
||||||
|
// insignificant space characters elided.
|
||||||
|
func Compact(dst *bytes.Buffer, src []byte) error {
|
||||||
|
return compact(dst, src, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func compact(dst *bytes.Buffer, src []byte, escape bool) error {
|
||||||
|
origLen := dst.Len()
|
||||||
|
var scan scanner
|
||||||
|
scan.reset()
|
||||||
|
start := 0
|
||||||
|
for i, c := range src {
|
||||||
|
if escape && (c == '<' || c == '>' || c == '&') {
|
||||||
|
if start < i {
|
||||||
|
dst.Write(src[start:i])
|
||||||
|
}
|
||||||
|
dst.WriteString(`\u00`)
|
||||||
|
dst.WriteByte(hex[c>>4])
|
||||||
|
dst.WriteByte(hex[c&0xF])
|
||||||
|
start = i + 1
|
||||||
|
}
|
||||||
|
// Convert U+2028 and U+2029 (E2 80 A8 and E2 80 A9).
|
||||||
|
if c == 0xE2 && i+2 < len(src) && src[i+1] == 0x80 && src[i+2]&^1 == 0xA8 {
|
||||||
|
if start < i {
|
||||||
|
dst.Write(src[start:i])
|
||||||
|
}
|
||||||
|
dst.WriteString(`\u202`)
|
||||||
|
dst.WriteByte(hex[src[i+2]&0xF])
|
||||||
|
start = i + 3
|
||||||
|
}
|
||||||
|
v := scan.step(&scan, c)
|
||||||
|
if v >= scanSkipSpace {
|
||||||
|
if v == scanError {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if start < i {
|
||||||
|
dst.Write(src[start:i])
|
||||||
|
}
|
||||||
|
start = i + 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if scan.eof() == scanError {
|
||||||
|
dst.Truncate(origLen)
|
||||||
|
return scan.err
|
||||||
|
}
|
||||||
|
if start < len(src) {
|
||||||
|
dst.Write(src[start:])
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func newline(dst *bytes.Buffer, prefix, indent string, depth int) {
|
||||||
|
dst.WriteByte('\n')
|
||||||
|
dst.WriteString(prefix)
|
||||||
|
for i := 0; i < depth; i++ {
|
||||||
|
dst.WriteString(indent)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Indent appends to dst an indented form of the JSON-encoded src.
|
||||||
|
// Each element in a JSON object or array begins on a new,
|
||||||
|
// indented line beginning with prefix followed by one or more
|
||||||
|
// copies of indent according to the indentation nesting.
|
||||||
|
// The data appended to dst does not begin with the prefix nor
|
||||||
|
// any indentation, to make it easier to embed inside other formatted JSON data.
|
||||||
|
// Although leading space characters (space, tab, carriage return, newline)
|
||||||
|
// at the beginning of src are dropped, trailing space characters
|
||||||
|
// at the end of src are preserved and copied to dst.
|
||||||
|
// For example, if src has no trailing spaces, neither will dst;
|
||||||
|
// if src ends in a trailing newline, so will dst.
|
||||||
|
func Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error {
|
||||||
|
origLen := dst.Len()
|
||||||
|
var scan scanner
|
||||||
|
scan.reset()
|
||||||
|
needIndent := false
|
||||||
|
depth := 0
|
||||||
|
for _, c := range src {
|
||||||
|
scan.bytes++
|
||||||
|
v := scan.step(&scan, c)
|
||||||
|
if v == scanSkipSpace {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if v == scanError {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if needIndent && v != scanEndObject && v != scanEndArray {
|
||||||
|
needIndent = false
|
||||||
|
depth++
|
||||||
|
newline(dst, prefix, indent, depth)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Emit semantically uninteresting bytes
|
||||||
|
// (in particular, punctuation in strings) unmodified.
|
||||||
|
if v == scanContinue {
|
||||||
|
dst.WriteByte(c)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add spacing around real punctuation.
|
||||||
|
switch c {
|
||||||
|
case '{', '[':
|
||||||
|
// delay indent so that empty object and array are formatted as {} and [].
|
||||||
|
needIndent = true
|
||||||
|
dst.WriteByte(c)
|
||||||
|
|
||||||
|
case ',':
|
||||||
|
dst.WriteByte(c)
|
||||||
|
newline(dst, prefix, indent, depth)
|
||||||
|
|
||||||
|
case ':':
|
||||||
|
dst.WriteByte(c)
|
||||||
|
dst.WriteByte(' ')
|
||||||
|
|
||||||
|
case '}', ']':
|
||||||
|
if needIndent {
|
||||||
|
// suppress indent in empty object/array
|
||||||
|
needIndent = false
|
||||||
|
} else {
|
||||||
|
depth--
|
||||||
|
newline(dst, prefix, indent, depth)
|
||||||
|
}
|
||||||
|
dst.WriteByte(c)
|
||||||
|
|
||||||
|
default:
|
||||||
|
dst.WriteByte(c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if scan.eof() == scanError {
|
||||||
|
dst.Truncate(origLen)
|
||||||
|
return scan.err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
|
@ -0,0 +1,623 @@
|
||||||
|
// Copyright 2010 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package json
|
||||||
|
|
||||||
|
// JSON value parser state machine.
|
||||||
|
// Just about at the limit of what is reasonable to write by hand.
|
||||||
|
// Some parts are a bit tedious, but overall it nicely factors out the
|
||||||
|
// otherwise common code from the multiple scanning functions
|
||||||
|
// in this package (Compact, Indent, checkValid, nextValue, etc).
|
||||||
|
//
|
||||||
|
// This file starts with two simple examples using the scanner
|
||||||
|
// before diving into the scanner itself.
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// checkValid verifies that data is valid JSON-encoded data.
|
||||||
|
// scan is passed in for use by checkValid to avoid an allocation.
|
||||||
|
func checkValid(data []byte, scan *scanner) error {
|
||||||
|
scan.reset()
|
||||||
|
for _, c := range data {
|
||||||
|
scan.bytes++
|
||||||
|
if scan.step(scan, c) == scanError {
|
||||||
|
return scan.err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if scan.eof() == scanError {
|
||||||
|
return scan.err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// nextValue splits data after the next whole JSON value,
|
||||||
|
// returning that value and the bytes that follow it as separate slices.
|
||||||
|
// scan is passed in for use by nextValue to avoid an allocation.
|
||||||
|
func nextValue(data []byte, scan *scanner) (value, rest []byte, err error) {
|
||||||
|
scan.reset()
|
||||||
|
for i, c := range data {
|
||||||
|
v := scan.step(scan, c)
|
||||||
|
if v >= scanEndObject {
|
||||||
|
switch v {
|
||||||
|
// probe the scanner with a space to determine whether we will
|
||||||
|
// get scanEnd on the next character. Otherwise, if the next character
|
||||||
|
// is not a space, scanEndTop allocates a needless error.
|
||||||
|
case scanEndObject, scanEndArray:
|
||||||
|
if scan.step(scan, ' ') == scanEnd {
|
||||||
|
return data[:i+1], data[i+1:], nil
|
||||||
|
}
|
||||||
|
case scanError:
|
||||||
|
return nil, nil, scan.err
|
||||||
|
case scanEnd:
|
||||||
|
return data[:i], data[i:], nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if scan.eof() == scanError {
|
||||||
|
return nil, nil, scan.err
|
||||||
|
}
|
||||||
|
return data, nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// A SyntaxError is a description of a JSON syntax error.
|
||||||
|
type SyntaxError struct {
|
||||||
|
msg string // description of error
|
||||||
|
Offset int64 // error occurred after reading Offset bytes
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *SyntaxError) Error() string { return e.msg }
|
||||||
|
|
||||||
|
// A scanner is a JSON scanning state machine.
|
||||||
|
// Callers call scan.reset() and then pass bytes in one at a time
|
||||||
|
// by calling scan.step(&scan, c) for each byte.
|
||||||
|
// The return value, referred to as an opcode, tells the
|
||||||
|
// caller about significant parsing events like beginning
|
||||||
|
// and ending literals, objects, and arrays, so that the
|
||||||
|
// caller can follow along if it wishes.
|
||||||
|
// The return value scanEnd indicates that a single top-level
|
||||||
|
// JSON value has been completed, *before* the byte that
|
||||||
|
// just got passed in. (The indication must be delayed in order
|
||||||
|
// to recognize the end of numbers: is 123 a whole value or
|
||||||
|
// the beginning of 12345e+6?).
|
||||||
|
type scanner struct {
|
||||||
|
// The step is a func to be called to execute the next transition.
|
||||||
|
// Also tried using an integer constant and a single func
|
||||||
|
// with a switch, but using the func directly was 10% faster
|
||||||
|
// on a 64-bit Mac Mini, and it's nicer to read.
|
||||||
|
step func(*scanner, byte) int
|
||||||
|
|
||||||
|
// Reached end of top-level value.
|
||||||
|
endTop bool
|
||||||
|
|
||||||
|
// Stack of what we're in the middle of - array values, object keys, object values.
|
||||||
|
parseState []int
|
||||||
|
|
||||||
|
// Error that happened, if any.
|
||||||
|
err error
|
||||||
|
|
||||||
|
// 1-byte redo (see undo method)
|
||||||
|
redo bool
|
||||||
|
redoCode int
|
||||||
|
redoState func(*scanner, byte) int
|
||||||
|
|
||||||
|
// total bytes consumed, updated by decoder.Decode
|
||||||
|
bytes int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// These values are returned by the state transition functions
|
||||||
|
// assigned to scanner.state and the method scanner.eof.
|
||||||
|
// They give details about the current state of the scan that
|
||||||
|
// callers might be interested to know about.
|
||||||
|
// It is okay to ignore the return value of any particular
|
||||||
|
// call to scanner.state: if one call returns scanError,
|
||||||
|
// every subsequent call will return scanError too.
|
||||||
|
const (
|
||||||
|
// Continue.
|
||||||
|
scanContinue = iota // uninteresting byte
|
||||||
|
scanBeginLiteral // end implied by next result != scanContinue
|
||||||
|
scanBeginObject // begin object
|
||||||
|
scanObjectKey // just finished object key (string)
|
||||||
|
scanObjectValue // just finished non-last object value
|
||||||
|
scanEndObject // end object (implies scanObjectValue if possible)
|
||||||
|
scanBeginArray // begin array
|
||||||
|
scanArrayValue // just finished array value
|
||||||
|
scanEndArray // end array (implies scanArrayValue if possible)
|
||||||
|
scanSkipSpace // space byte; can skip; known to be last "continue" result
|
||||||
|
|
||||||
|
// Stop.
|
||||||
|
scanEnd // top-level value ended *before* this byte; known to be first "stop" result
|
||||||
|
scanError // hit an error, scanner.err.
|
||||||
|
)
|
||||||
|
|
||||||
|
// These values are stored in the parseState stack.
|
||||||
|
// They give the current state of a composite value
|
||||||
|
// being scanned. If the parser is inside a nested value
|
||||||
|
// the parseState describes the nested state, outermost at entry 0.
|
||||||
|
const (
|
||||||
|
parseObjectKey = iota // parsing object key (before colon)
|
||||||
|
parseObjectValue // parsing object value (after colon)
|
||||||
|
parseArrayValue // parsing array value
|
||||||
|
)
|
||||||
|
|
||||||
|
// reset prepares the scanner for use.
|
||||||
|
// It must be called before calling s.step.
|
||||||
|
func (s *scanner) reset() {
|
||||||
|
s.step = stateBeginValue
|
||||||
|
s.parseState = s.parseState[0:0]
|
||||||
|
s.err = nil
|
||||||
|
s.redo = false
|
||||||
|
s.endTop = false
|
||||||
|
}
|
||||||
|
|
||||||
|
// eof tells the scanner that the end of input has been reached.
|
||||||
|
// It returns a scan status just as s.step does.
|
||||||
|
func (s *scanner) eof() int {
|
||||||
|
if s.err != nil {
|
||||||
|
return scanError
|
||||||
|
}
|
||||||
|
if s.endTop {
|
||||||
|
return scanEnd
|
||||||
|
}
|
||||||
|
s.step(s, ' ')
|
||||||
|
if s.endTop {
|
||||||
|
return scanEnd
|
||||||
|
}
|
||||||
|
if s.err == nil {
|
||||||
|
s.err = &SyntaxError{"unexpected end of JSON input", s.bytes}
|
||||||
|
}
|
||||||
|
return scanError
|
||||||
|
}
|
||||||
|
|
||||||
|
// pushParseState pushes a new parse state p onto the parse stack.
|
||||||
|
func (s *scanner) pushParseState(p int) {
|
||||||
|
s.parseState = append(s.parseState, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// popParseState pops a parse state (already obtained) off the stack
|
||||||
|
// and updates s.step accordingly.
|
||||||
|
func (s *scanner) popParseState() {
|
||||||
|
n := len(s.parseState) - 1
|
||||||
|
s.parseState = s.parseState[0:n]
|
||||||
|
s.redo = false
|
||||||
|
if n == 0 {
|
||||||
|
s.step = stateEndTop
|
||||||
|
s.endTop = true
|
||||||
|
} else {
|
||||||
|
s.step = stateEndValue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func isSpace(c byte) bool {
|
||||||
|
return c == ' ' || c == '\t' || c == '\r' || c == '\n'
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateBeginValueOrEmpty is the state after reading `[`.
|
||||||
|
func stateBeginValueOrEmpty(s *scanner, c byte) int {
|
||||||
|
if c <= ' ' && isSpace(c) {
|
||||||
|
return scanSkipSpace
|
||||||
|
}
|
||||||
|
if c == ']' {
|
||||||
|
return stateEndValue(s, c)
|
||||||
|
}
|
||||||
|
return stateBeginValue(s, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateBeginValue is the state at the beginning of the input.
|
||||||
|
func stateBeginValue(s *scanner, c byte) int {
|
||||||
|
if c <= ' ' && isSpace(c) {
|
||||||
|
return scanSkipSpace
|
||||||
|
}
|
||||||
|
switch c {
|
||||||
|
case '{':
|
||||||
|
s.step = stateBeginStringOrEmpty
|
||||||
|
s.pushParseState(parseObjectKey)
|
||||||
|
return scanBeginObject
|
||||||
|
case '[':
|
||||||
|
s.step = stateBeginValueOrEmpty
|
||||||
|
s.pushParseState(parseArrayValue)
|
||||||
|
return scanBeginArray
|
||||||
|
case '"':
|
||||||
|
s.step = stateInString
|
||||||
|
return scanBeginLiteral
|
||||||
|
case '-':
|
||||||
|
s.step = stateNeg
|
||||||
|
return scanBeginLiteral
|
||||||
|
case '0': // beginning of 0.123
|
||||||
|
s.step = state0
|
||||||
|
return scanBeginLiteral
|
||||||
|
case 't': // beginning of true
|
||||||
|
s.step = stateT
|
||||||
|
return scanBeginLiteral
|
||||||
|
case 'f': // beginning of false
|
||||||
|
s.step = stateF
|
||||||
|
return scanBeginLiteral
|
||||||
|
case 'n': // beginning of null
|
||||||
|
s.step = stateN
|
||||||
|
return scanBeginLiteral
|
||||||
|
}
|
||||||
|
if '1' <= c && c <= '9' { // beginning of 1234.5
|
||||||
|
s.step = state1
|
||||||
|
return scanBeginLiteral
|
||||||
|
}
|
||||||
|
return s.error(c, "looking for beginning of value")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateBeginStringOrEmpty is the state after reading `{`.
|
||||||
|
func stateBeginStringOrEmpty(s *scanner, c byte) int {
|
||||||
|
if c <= ' ' && isSpace(c) {
|
||||||
|
return scanSkipSpace
|
||||||
|
}
|
||||||
|
if c == '}' {
|
||||||
|
n := len(s.parseState)
|
||||||
|
s.parseState[n-1] = parseObjectValue
|
||||||
|
return stateEndValue(s, c)
|
||||||
|
}
|
||||||
|
return stateBeginString(s, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateBeginString is the state after reading `{"key": value,`.
|
||||||
|
func stateBeginString(s *scanner, c byte) int {
|
||||||
|
if c <= ' ' && isSpace(c) {
|
||||||
|
return scanSkipSpace
|
||||||
|
}
|
||||||
|
if c == '"' {
|
||||||
|
s.step = stateInString
|
||||||
|
return scanBeginLiteral
|
||||||
|
}
|
||||||
|
return s.error(c, "looking for beginning of object key string")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateEndValue is the state after completing a value,
|
||||||
|
// such as after reading `{}` or `true` or `["x"`.
|
||||||
|
func stateEndValue(s *scanner, c byte) int {
|
||||||
|
n := len(s.parseState)
|
||||||
|
if n == 0 {
|
||||||
|
// Completed top-level before the current byte.
|
||||||
|
s.step = stateEndTop
|
||||||
|
s.endTop = true
|
||||||
|
return stateEndTop(s, c)
|
||||||
|
}
|
||||||
|
if c <= ' ' && isSpace(c) {
|
||||||
|
s.step = stateEndValue
|
||||||
|
return scanSkipSpace
|
||||||
|
}
|
||||||
|
ps := s.parseState[n-1]
|
||||||
|
switch ps {
|
||||||
|
case parseObjectKey:
|
||||||
|
if c == ':' {
|
||||||
|
s.parseState[n-1] = parseObjectValue
|
||||||
|
s.step = stateBeginValue
|
||||||
|
return scanObjectKey
|
||||||
|
}
|
||||||
|
return s.error(c, "after object key")
|
||||||
|
case parseObjectValue:
|
||||||
|
if c == ',' {
|
||||||
|
s.parseState[n-1] = parseObjectKey
|
||||||
|
s.step = stateBeginString
|
||||||
|
return scanObjectValue
|
||||||
|
}
|
||||||
|
if c == '}' {
|
||||||
|
s.popParseState()
|
||||||
|
return scanEndObject
|
||||||
|
}
|
||||||
|
return s.error(c, "after object key:value pair")
|
||||||
|
case parseArrayValue:
|
||||||
|
if c == ',' {
|
||||||
|
s.step = stateBeginValue
|
||||||
|
return scanArrayValue
|
||||||
|
}
|
||||||
|
if c == ']' {
|
||||||
|
s.popParseState()
|
||||||
|
return scanEndArray
|
||||||
|
}
|
||||||
|
return s.error(c, "after array element")
|
||||||
|
}
|
||||||
|
return s.error(c, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateEndTop is the state after finishing the top-level value,
|
||||||
|
// such as after reading `{}` or `[1,2,3]`.
|
||||||
|
// Only space characters should be seen now.
|
||||||
|
func stateEndTop(s *scanner, c byte) int {
|
||||||
|
if c != ' ' && c != '\t' && c != '\r' && c != '\n' {
|
||||||
|
// Complain about non-space byte on next call.
|
||||||
|
s.error(c, "after top-level value")
|
||||||
|
}
|
||||||
|
return scanEnd
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateInString is the state after reading `"`.
|
||||||
|
func stateInString(s *scanner, c byte) int {
|
||||||
|
if c == '"' {
|
||||||
|
s.step = stateEndValue
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
if c == '\\' {
|
||||||
|
s.step = stateInStringEsc
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
if c < 0x20 {
|
||||||
|
return s.error(c, "in string literal")
|
||||||
|
}
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateInStringEsc is the state after reading `"\` during a quoted string.
|
||||||
|
func stateInStringEsc(s *scanner, c byte) int {
|
||||||
|
switch c {
|
||||||
|
case 'b', 'f', 'n', 'r', 't', '\\', '/', '"':
|
||||||
|
s.step = stateInString
|
||||||
|
return scanContinue
|
||||||
|
case 'u':
|
||||||
|
s.step = stateInStringEscU
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in string escape code")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateInStringEscU is the state after reading `"\u` during a quoted string.
|
||||||
|
func stateInStringEscU(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' || 'a' <= c && c <= 'f' || 'A' <= c && c <= 'F' {
|
||||||
|
s.step = stateInStringEscU1
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
// numbers
|
||||||
|
return s.error(c, "in \\u hexadecimal character escape")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateInStringEscU1 is the state after reading `"\u1` during a quoted string.
|
||||||
|
func stateInStringEscU1(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' || 'a' <= c && c <= 'f' || 'A' <= c && c <= 'F' {
|
||||||
|
s.step = stateInStringEscU12
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
// numbers
|
||||||
|
return s.error(c, "in \\u hexadecimal character escape")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateInStringEscU12 is the state after reading `"\u12` during a quoted string.
|
||||||
|
func stateInStringEscU12(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' || 'a' <= c && c <= 'f' || 'A' <= c && c <= 'F' {
|
||||||
|
s.step = stateInStringEscU123
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
// numbers
|
||||||
|
return s.error(c, "in \\u hexadecimal character escape")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateInStringEscU123 is the state after reading `"\u123` during a quoted string.
|
||||||
|
func stateInStringEscU123(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' || 'a' <= c && c <= 'f' || 'A' <= c && c <= 'F' {
|
||||||
|
s.step = stateInString
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
// numbers
|
||||||
|
return s.error(c, "in \\u hexadecimal character escape")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateNeg is the state after reading `-` during a number.
|
||||||
|
func stateNeg(s *scanner, c byte) int {
|
||||||
|
if c == '0' {
|
||||||
|
s.step = state0
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
if '1' <= c && c <= '9' {
|
||||||
|
s.step = state1
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in numeric literal")
|
||||||
|
}
|
||||||
|
|
||||||
|
// state1 is the state after reading a non-zero integer during a number,
|
||||||
|
// such as after reading `1` or `100` but not `0`.
|
||||||
|
func state1(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' {
|
||||||
|
s.step = state1
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return state0(s, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// state0 is the state after reading `0` during a number.
|
||||||
|
func state0(s *scanner, c byte) int {
|
||||||
|
if c == '.' {
|
||||||
|
s.step = stateDot
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
if c == 'e' || c == 'E' {
|
||||||
|
s.step = stateE
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return stateEndValue(s, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateDot is the state after reading the integer and decimal point in a number,
|
||||||
|
// such as after reading `1.`.
|
||||||
|
func stateDot(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' {
|
||||||
|
s.step = stateDot0
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "after decimal point in numeric literal")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateDot0 is the state after reading the integer, decimal point, and subsequent
|
||||||
|
// digits of a number, such as after reading `3.14`.
|
||||||
|
func stateDot0(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' {
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
if c == 'e' || c == 'E' {
|
||||||
|
s.step = stateE
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return stateEndValue(s, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateE is the state after reading the mantissa and e in a number,
|
||||||
|
// such as after reading `314e` or `0.314e`.
|
||||||
|
func stateE(s *scanner, c byte) int {
|
||||||
|
if c == '+' || c == '-' {
|
||||||
|
s.step = stateESign
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return stateESign(s, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateESign is the state after reading the mantissa, e, and sign in a number,
|
||||||
|
// such as after reading `314e-` or `0.314e+`.
|
||||||
|
func stateESign(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' {
|
||||||
|
s.step = stateE0
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in exponent of numeric literal")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateE0 is the state after reading the mantissa, e, optional sign,
|
||||||
|
// and at least one digit of the exponent in a number,
|
||||||
|
// such as after reading `314e-2` or `0.314e+1` or `3.14e0`.
|
||||||
|
func stateE0(s *scanner, c byte) int {
|
||||||
|
if '0' <= c && c <= '9' {
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return stateEndValue(s, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateT is the state after reading `t`.
|
||||||
|
func stateT(s *scanner, c byte) int {
|
||||||
|
if c == 'r' {
|
||||||
|
s.step = stateTr
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal true (expecting 'r')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateTr is the state after reading `tr`.
|
||||||
|
func stateTr(s *scanner, c byte) int {
|
||||||
|
if c == 'u' {
|
||||||
|
s.step = stateTru
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal true (expecting 'u')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateTru is the state after reading `tru`.
|
||||||
|
func stateTru(s *scanner, c byte) int {
|
||||||
|
if c == 'e' {
|
||||||
|
s.step = stateEndValue
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal true (expecting 'e')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateF is the state after reading `f`.
|
||||||
|
func stateF(s *scanner, c byte) int {
|
||||||
|
if c == 'a' {
|
||||||
|
s.step = stateFa
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal false (expecting 'a')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateFa is the state after reading `fa`.
|
||||||
|
func stateFa(s *scanner, c byte) int {
|
||||||
|
if c == 'l' {
|
||||||
|
s.step = stateFal
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal false (expecting 'l')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateFal is the state after reading `fal`.
|
||||||
|
func stateFal(s *scanner, c byte) int {
|
||||||
|
if c == 's' {
|
||||||
|
s.step = stateFals
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal false (expecting 's')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateFals is the state after reading `fals`.
|
||||||
|
func stateFals(s *scanner, c byte) int {
|
||||||
|
if c == 'e' {
|
||||||
|
s.step = stateEndValue
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal false (expecting 'e')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateN is the state after reading `n`.
|
||||||
|
func stateN(s *scanner, c byte) int {
|
||||||
|
if c == 'u' {
|
||||||
|
s.step = stateNu
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal null (expecting 'u')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateNu is the state after reading `nu`.
|
||||||
|
func stateNu(s *scanner, c byte) int {
|
||||||
|
if c == 'l' {
|
||||||
|
s.step = stateNul
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal null (expecting 'l')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateNul is the state after reading `nul`.
|
||||||
|
func stateNul(s *scanner, c byte) int {
|
||||||
|
if c == 'l' {
|
||||||
|
s.step = stateEndValue
|
||||||
|
return scanContinue
|
||||||
|
}
|
||||||
|
return s.error(c, "in literal null (expecting 'l')")
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateError is the state after reaching a syntax error,
|
||||||
|
// such as after reading `[1}` or `5.1.2`.
|
||||||
|
func stateError(s *scanner, c byte) int {
|
||||||
|
return scanError
|
||||||
|
}
|
||||||
|
|
||||||
|
// error records an error and switches to the error state.
|
||||||
|
func (s *scanner) error(c byte, context string) int {
|
||||||
|
s.step = stateError
|
||||||
|
s.err = &SyntaxError{"invalid character " + quoteChar(c) + " " + context, s.bytes}
|
||||||
|
return scanError
|
||||||
|
}
|
||||||
|
|
||||||
|
// quoteChar formats c as a quoted character literal
|
||||||
|
func quoteChar(c byte) string {
|
||||||
|
// special cases - different from quoted strings
|
||||||
|
if c == '\'' {
|
||||||
|
return `'\''`
|
||||||
|
}
|
||||||
|
if c == '"' {
|
||||||
|
return `'"'`
|
||||||
|
}
|
||||||
|
|
||||||
|
// use quoted string with different quotation marks
|
||||||
|
s := strconv.Quote(string(c))
|
||||||
|
return "'" + s[1:len(s)-1] + "'"
|
||||||
|
}
|
||||||
|
|
||||||
|
// undo causes the scanner to return scanCode from the next state transition.
|
||||||
|
// This gives callers a simple 1-byte undo mechanism.
|
||||||
|
func (s *scanner) undo(scanCode int) {
|
||||||
|
if s.redo {
|
||||||
|
panic("json: invalid use of scanner")
|
||||||
|
}
|
||||||
|
s.redoCode = scanCode
|
||||||
|
s.redoState = s.step
|
||||||
|
s.step = stateRedo
|
||||||
|
s.redo = true
|
||||||
|
}
|
||||||
|
|
||||||
|
// stateRedo helps implement the scanner's 1-byte undo.
|
||||||
|
func stateRedo(s *scanner, c byte) int {
|
||||||
|
s.redo = false
|
||||||
|
s.step = s.redoState
|
||||||
|
return s.redoCode
|
||||||
|
}
|
|
@ -0,0 +1,484 @@
|
||||||
|
// Copyright 2010 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package json
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A Decoder reads and decodes JSON objects from an input stream.
|
||||||
|
type Decoder struct {
|
||||||
|
r io.Reader
|
||||||
|
buf []byte
|
||||||
|
d decodeState
|
||||||
|
scanp int // start of unread data in buf
|
||||||
|
scan scanner
|
||||||
|
err error
|
||||||
|
|
||||||
|
tokenState int
|
||||||
|
tokenStack []int
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewDecoder returns a new decoder that reads from r.
|
||||||
|
//
|
||||||
|
// The decoder introduces its own buffering and may
|
||||||
|
// read data from r beyond the JSON values requested.
|
||||||
|
func NewDecoder(r io.Reader) *Decoder {
|
||||||
|
return &Decoder{r: r}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deprecated: Use `SetNumberType` instead
|
||||||
|
// UseNumber causes the Decoder to unmarshal a number into an interface{} as a
|
||||||
|
// Number instead of as a float64.
|
||||||
|
func (dec *Decoder) UseNumber() { dec.d.numberType = UnmarshalJSONNumber }
|
||||||
|
|
||||||
|
// SetNumberType causes the Decoder to unmarshal a number into an interface{} as a
|
||||||
|
// Number, float64 or int64 depending on `t` enum value.
|
||||||
|
func (dec *Decoder) SetNumberType(t NumberUnmarshalType) { dec.d.numberType = t }
|
||||||
|
|
||||||
|
// Decode reads the next JSON-encoded value from its
|
||||||
|
// input and stores it in the value pointed to by v.
|
||||||
|
//
|
||||||
|
// See the documentation for Unmarshal for details about
|
||||||
|
// the conversion of JSON into a Go value.
|
||||||
|
func (dec *Decoder) Decode(v interface{}) error {
|
||||||
|
if dec.err != nil {
|
||||||
|
return dec.err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := dec.tokenPrepareForDecode(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if !dec.tokenValueAllowed() {
|
||||||
|
return &SyntaxError{msg: "not at beginning of value"}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read whole value into buffer.
|
||||||
|
n, err := dec.readValue()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
dec.d.init(dec.buf[dec.scanp : dec.scanp+n])
|
||||||
|
dec.scanp += n
|
||||||
|
|
||||||
|
// Don't save err from unmarshal into dec.err:
|
||||||
|
// the connection is still usable since we read a complete JSON
|
||||||
|
// object from it before the error happened.
|
||||||
|
err = dec.d.unmarshal(v)
|
||||||
|
|
||||||
|
// fixup token streaming state
|
||||||
|
dec.tokenValueEnd()
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Buffered returns a reader of the data remaining in the Decoder's
|
||||||
|
// buffer. The reader is valid until the next call to Decode.
|
||||||
|
func (dec *Decoder) Buffered() io.Reader {
|
||||||
|
return bytes.NewReader(dec.buf[dec.scanp:])
|
||||||
|
}
|
||||||
|
|
||||||
|
// readValue reads a JSON value into dec.buf.
|
||||||
|
// It returns the length of the encoding.
|
||||||
|
func (dec *Decoder) readValue() (int, error) {
|
||||||
|
dec.scan.reset()
|
||||||
|
|
||||||
|
scanp := dec.scanp
|
||||||
|
var err error
|
||||||
|
Input:
|
||||||
|
for {
|
||||||
|
// Look in the buffer for a new value.
|
||||||
|
for i, c := range dec.buf[scanp:] {
|
||||||
|
dec.scan.bytes++
|
||||||
|
v := dec.scan.step(&dec.scan, c)
|
||||||
|
if v == scanEnd {
|
||||||
|
scanp += i
|
||||||
|
break Input
|
||||||
|
}
|
||||||
|
// scanEnd is delayed one byte.
|
||||||
|
// We might block trying to get that byte from src,
|
||||||
|
// so instead invent a space byte.
|
||||||
|
if (v == scanEndObject || v == scanEndArray) && dec.scan.step(&dec.scan, ' ') == scanEnd {
|
||||||
|
scanp += i + 1
|
||||||
|
break Input
|
||||||
|
}
|
||||||
|
if v == scanError {
|
||||||
|
dec.err = dec.scan.err
|
||||||
|
return 0, dec.scan.err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
scanp = len(dec.buf)
|
||||||
|
|
||||||
|
// Did the last read have an error?
|
||||||
|
// Delayed until now to allow buffer scan.
|
||||||
|
if err != nil {
|
||||||
|
if err == io.EOF {
|
||||||
|
if dec.scan.step(&dec.scan, ' ') == scanEnd {
|
||||||
|
break Input
|
||||||
|
}
|
||||||
|
if nonSpace(dec.buf) {
|
||||||
|
err = io.ErrUnexpectedEOF
|
||||||
|
}
|
||||||
|
}
|
||||||
|
dec.err = err
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
n := scanp - dec.scanp
|
||||||
|
err = dec.refill()
|
||||||
|
scanp = dec.scanp + n
|
||||||
|
}
|
||||||
|
return scanp - dec.scanp, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dec *Decoder) refill() error {
|
||||||
|
// Make room to read more into the buffer.
|
||||||
|
// First slide down data already consumed.
|
||||||
|
if dec.scanp > 0 {
|
||||||
|
n := copy(dec.buf, dec.buf[dec.scanp:])
|
||||||
|
dec.buf = dec.buf[:n]
|
||||||
|
dec.scanp = 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Grow buffer if not large enough.
|
||||||
|
const minRead = 512
|
||||||
|
if cap(dec.buf)-len(dec.buf) < minRead {
|
||||||
|
newBuf := make([]byte, len(dec.buf), 2*cap(dec.buf)+minRead)
|
||||||
|
copy(newBuf, dec.buf)
|
||||||
|
dec.buf = newBuf
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read. Delay error for next iteration (after scan).
|
||||||
|
n, err := dec.r.Read(dec.buf[len(dec.buf):cap(dec.buf)])
|
||||||
|
dec.buf = dec.buf[0 : len(dec.buf)+n]
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func nonSpace(b []byte) bool {
|
||||||
|
for _, c := range b {
|
||||||
|
if !isSpace(c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// An Encoder writes JSON objects to an output stream.
|
||||||
|
type Encoder struct {
|
||||||
|
w io.Writer
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewEncoder returns a new encoder that writes to w.
|
||||||
|
func NewEncoder(w io.Writer) *Encoder {
|
||||||
|
return &Encoder{w: w}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encode writes the JSON encoding of v to the stream,
|
||||||
|
// followed by a newline character.
|
||||||
|
//
|
||||||
|
// See the documentation for Marshal for details about the
|
||||||
|
// conversion of Go values to JSON.
|
||||||
|
func (enc *Encoder) Encode(v interface{}) error {
|
||||||
|
if enc.err != nil {
|
||||||
|
return enc.err
|
||||||
|
}
|
||||||
|
e := newEncodeState()
|
||||||
|
err := e.marshal(v)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Terminate each value with a newline.
|
||||||
|
// This makes the output look a little nicer
|
||||||
|
// when debugging, and some kind of space
|
||||||
|
// is required if the encoded value was a number,
|
||||||
|
// so that the reader knows there aren't more
|
||||||
|
// digits coming.
|
||||||
|
e.WriteByte('\n')
|
||||||
|
|
||||||
|
if _, err = enc.w.Write(e.Bytes()); err != nil {
|
||||||
|
enc.err = err
|
||||||
|
}
|
||||||
|
encodeStatePool.Put(e)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// RawMessage is a raw encoded JSON object.
|
||||||
|
// It implements Marshaler and Unmarshaler and can
|
||||||
|
// be used to delay JSON decoding or precompute a JSON encoding.
|
||||||
|
type RawMessage []byte
|
||||||
|
|
||||||
|
// MarshalJSON returns *m as the JSON encoding of m.
|
||||||
|
func (m *RawMessage) MarshalJSON() ([]byte, error) {
|
||||||
|
return *m, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON sets *m to a copy of data.
|
||||||
|
func (m *RawMessage) UnmarshalJSON(data []byte) error {
|
||||||
|
if m == nil {
|
||||||
|
return errors.New("json.RawMessage: UnmarshalJSON on nil pointer")
|
||||||
|
}
|
||||||
|
*m = append((*m)[0:0], data...)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ Marshaler = (*RawMessage)(nil)
|
||||||
|
var _ Unmarshaler = (*RawMessage)(nil)
|
||||||
|
|
||||||
|
// A Token holds a value of one of these types:
|
||||||
|
//
|
||||||
|
// Delim, for the four JSON delimiters [ ] { }
|
||||||
|
// bool, for JSON booleans
|
||||||
|
// float64, for JSON numbers
|
||||||
|
// Number, for JSON numbers
|
||||||
|
// string, for JSON string literals
|
||||||
|
// nil, for JSON null
|
||||||
|
type Token interface{}
|
||||||
|
|
||||||
|
const (
|
||||||
|
tokenTopValue = iota
|
||||||
|
tokenArrayStart
|
||||||
|
tokenArrayValue
|
||||||
|
tokenArrayComma
|
||||||
|
tokenObjectStart
|
||||||
|
tokenObjectKey
|
||||||
|
tokenObjectColon
|
||||||
|
tokenObjectValue
|
||||||
|
tokenObjectComma
|
||||||
|
)
|
||||||
|
|
||||||
|
// advance tokenstate from a separator state to a value state
|
||||||
|
func (dec *Decoder) tokenPrepareForDecode() error {
|
||||||
|
// Note: Not calling peek before switch, to avoid
|
||||||
|
// putting peek into the standard Decode path.
|
||||||
|
// peek is only called when using the Token API.
|
||||||
|
switch dec.tokenState {
|
||||||
|
case tokenArrayComma:
|
||||||
|
c, err := dec.peek()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c != ',' {
|
||||||
|
return &SyntaxError{"expected comma after array element", 0}
|
||||||
|
}
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenState = tokenArrayValue
|
||||||
|
case tokenObjectColon:
|
||||||
|
c, err := dec.peek()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c != ':' {
|
||||||
|
return &SyntaxError{"expected colon after object key", 0}
|
||||||
|
}
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenState = tokenObjectValue
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dec *Decoder) tokenValueAllowed() bool {
|
||||||
|
switch dec.tokenState {
|
||||||
|
case tokenTopValue, tokenArrayStart, tokenArrayValue, tokenObjectValue:
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dec *Decoder) tokenValueEnd() {
|
||||||
|
switch dec.tokenState {
|
||||||
|
case tokenArrayStart, tokenArrayValue:
|
||||||
|
dec.tokenState = tokenArrayComma
|
||||||
|
case tokenObjectValue:
|
||||||
|
dec.tokenState = tokenObjectComma
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A Delim is a JSON array or object delimiter, one of [ ] { or }.
|
||||||
|
type Delim rune
|
||||||
|
|
||||||
|
func (d Delim) String() string {
|
||||||
|
return string(d)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Token returns the next JSON token in the input stream.
|
||||||
|
// At the end of the input stream, Token returns nil, io.EOF.
|
||||||
|
//
|
||||||
|
// Token guarantees that the delimiters [ ] { } it returns are
|
||||||
|
// properly nested and matched: if Token encounters an unexpected
|
||||||
|
// delimiter in the input, it will return an error.
|
||||||
|
//
|
||||||
|
// The input stream consists of basic JSON values—bool, string,
|
||||||
|
// number, and null—along with delimiters [ ] { } of type Delim
|
||||||
|
// to mark the start and end of arrays and objects.
|
||||||
|
// Commas and colons are elided.
|
||||||
|
func (dec *Decoder) Token() (Token, error) {
|
||||||
|
for {
|
||||||
|
c, err := dec.peek()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
switch c {
|
||||||
|
case '[':
|
||||||
|
if !dec.tokenValueAllowed() {
|
||||||
|
return dec.tokenError(c)
|
||||||
|
}
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenStack = append(dec.tokenStack, dec.tokenState)
|
||||||
|
dec.tokenState = tokenArrayStart
|
||||||
|
return Delim('['), nil
|
||||||
|
|
||||||
|
case ']':
|
||||||
|
if dec.tokenState != tokenArrayStart && dec.tokenState != tokenArrayComma {
|
||||||
|
return dec.tokenError(c)
|
||||||
|
}
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenState = dec.tokenStack[len(dec.tokenStack)-1]
|
||||||
|
dec.tokenStack = dec.tokenStack[:len(dec.tokenStack)-1]
|
||||||
|
dec.tokenValueEnd()
|
||||||
|
return Delim(']'), nil
|
||||||
|
|
||||||
|
case '{':
|
||||||
|
if !dec.tokenValueAllowed() {
|
||||||
|
return dec.tokenError(c)
|
||||||
|
}
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenStack = append(dec.tokenStack, dec.tokenState)
|
||||||
|
dec.tokenState = tokenObjectStart
|
||||||
|
return Delim('{'), nil
|
||||||
|
|
||||||
|
case '}':
|
||||||
|
if dec.tokenState != tokenObjectStart && dec.tokenState != tokenObjectComma {
|
||||||
|
return dec.tokenError(c)
|
||||||
|
}
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenState = dec.tokenStack[len(dec.tokenStack)-1]
|
||||||
|
dec.tokenStack = dec.tokenStack[:len(dec.tokenStack)-1]
|
||||||
|
dec.tokenValueEnd()
|
||||||
|
return Delim('}'), nil
|
||||||
|
|
||||||
|
case ':':
|
||||||
|
if dec.tokenState != tokenObjectColon {
|
||||||
|
return dec.tokenError(c)
|
||||||
|
}
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenState = tokenObjectValue
|
||||||
|
continue
|
||||||
|
|
||||||
|
case ',':
|
||||||
|
if dec.tokenState == tokenArrayComma {
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenState = tokenArrayValue
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if dec.tokenState == tokenObjectComma {
|
||||||
|
dec.scanp++
|
||||||
|
dec.tokenState = tokenObjectKey
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
return dec.tokenError(c)
|
||||||
|
|
||||||
|
case '"':
|
||||||
|
if dec.tokenState == tokenObjectStart || dec.tokenState == tokenObjectKey {
|
||||||
|
var x string
|
||||||
|
old := dec.tokenState
|
||||||
|
dec.tokenState = tokenTopValue
|
||||||
|
err := dec.Decode(&x)
|
||||||
|
dec.tokenState = old
|
||||||
|
if err != nil {
|
||||||
|
clearOffset(err)
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
dec.tokenState = tokenObjectColon
|
||||||
|
return x, nil
|
||||||
|
}
|
||||||
|
fallthrough
|
||||||
|
|
||||||
|
default:
|
||||||
|
if !dec.tokenValueAllowed() {
|
||||||
|
return dec.tokenError(c)
|
||||||
|
}
|
||||||
|
var x interface{}
|
||||||
|
if err := dec.Decode(&x); err != nil {
|
||||||
|
clearOffset(err)
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return x, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func clearOffset(err error) {
|
||||||
|
if s, ok := err.(*SyntaxError); ok {
|
||||||
|
s.Offset = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dec *Decoder) tokenError(c byte) (Token, error) {
|
||||||
|
var context string
|
||||||
|
switch dec.tokenState {
|
||||||
|
case tokenTopValue:
|
||||||
|
context = " looking for beginning of value"
|
||||||
|
case tokenArrayStart, tokenArrayValue, tokenObjectValue:
|
||||||
|
context = " looking for beginning of value"
|
||||||
|
case tokenArrayComma:
|
||||||
|
context = " after array element"
|
||||||
|
case tokenObjectKey:
|
||||||
|
context = " looking for beginning of object key string"
|
||||||
|
case tokenObjectColon:
|
||||||
|
context = " after object key"
|
||||||
|
case tokenObjectComma:
|
||||||
|
context = " after object key:value pair"
|
||||||
|
}
|
||||||
|
return nil, &SyntaxError{"invalid character " + quoteChar(c) + " " + context, 0}
|
||||||
|
}
|
||||||
|
|
||||||
|
// More reports whether there is another element in the
|
||||||
|
// current array or object being parsed.
|
||||||
|
func (dec *Decoder) More() bool {
|
||||||
|
c, err := dec.peek()
|
||||||
|
return err == nil && c != ']' && c != '}'
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dec *Decoder) peek() (byte, error) {
|
||||||
|
var err error
|
||||||
|
for {
|
||||||
|
for i := dec.scanp; i < len(dec.buf); i++ {
|
||||||
|
c := dec.buf[i]
|
||||||
|
if isSpace(c) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
dec.scanp = i
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
// buffer has been scanned, now report any error
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
err = dec.refill()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
TODO
|
||||||
|
|
||||||
|
// EncodeToken writes the given JSON token to the stream.
|
||||||
|
// It returns an error if the delimiters [ ] { } are not properly used.
|
||||||
|
//
|
||||||
|
// EncodeToken does not call Flush, because usually it is part of
|
||||||
|
// a larger operation such as Encode, and those will call Flush when finished.
|
||||||
|
// Callers that create an Encoder and then invoke EncodeToken directly,
|
||||||
|
// without using Encode, need to call Flush when finished to ensure that
|
||||||
|
// the JSON is written to the underlying writer.
|
||||||
|
func (e *Encoder) EncodeToken(t Token) error {
|
||||||
|
...
|
||||||
|
}
|
||||||
|
|
||||||
|
*/
|
|
@ -0,0 +1,44 @@
|
||||||
|
// Copyright 2011 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package json
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// tagOptions is the string following a comma in a struct field's "json"
|
||||||
|
// tag, or the empty string. It does not include the leading comma.
|
||||||
|
type tagOptions string
|
||||||
|
|
||||||
|
// parseTag splits a struct field's json tag into its name and
|
||||||
|
// comma-separated options.
|
||||||
|
func parseTag(tag string) (string, tagOptions) {
|
||||||
|
if idx := strings.Index(tag, ","); idx != -1 {
|
||||||
|
return tag[:idx], tagOptions(tag[idx+1:])
|
||||||
|
}
|
||||||
|
return tag, tagOptions("")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Contains reports whether a comma-separated list of options
|
||||||
|
// contains a particular substr flag. substr must be surrounded by a
|
||||||
|
// string boundary or commas.
|
||||||
|
func (o tagOptions) Contains(optionName string) bool {
|
||||||
|
if len(o) == 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
s := string(o)
|
||||||
|
for s != "" {
|
||||||
|
var next string
|
||||||
|
i := strings.Index(s, ",")
|
||||||
|
if i >= 0 {
|
||||||
|
s, next = s[:i], s[i+1:]
|
||||||
|
}
|
||||||
|
if s == optionName {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
s = next
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
|
@ -0,0 +1,295 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/base64"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// rawJSONWebEncryption represents a raw JWE JSON object. Used for parsing/serializing.
|
||||||
|
type rawJSONWebEncryption struct {
|
||||||
|
Protected *byteBuffer `json:"protected,omitempty"`
|
||||||
|
Unprotected *rawHeader `json:"unprotected,omitempty"`
|
||||||
|
Header *rawHeader `json:"header,omitempty"`
|
||||||
|
Recipients []rawRecipientInfo `json:"recipients,omitempty"`
|
||||||
|
Aad *byteBuffer `json:"aad,omitempty"`
|
||||||
|
EncryptedKey *byteBuffer `json:"encrypted_key,omitempty"`
|
||||||
|
Iv *byteBuffer `json:"iv,omitempty"`
|
||||||
|
Ciphertext *byteBuffer `json:"ciphertext,omitempty"`
|
||||||
|
Tag *byteBuffer `json:"tag,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// rawRecipientInfo represents a raw JWE Per-Recipient header JSON object. Used for parsing/serializing.
|
||||||
|
type rawRecipientInfo struct {
|
||||||
|
Header *rawHeader `json:"header,omitempty"`
|
||||||
|
EncryptedKey string `json:"encrypted_key,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// JSONWebEncryption represents an encrypted JWE object after parsing.
|
||||||
|
type JSONWebEncryption struct {
|
||||||
|
Header Header
|
||||||
|
protected, unprotected *rawHeader
|
||||||
|
recipients []recipientInfo
|
||||||
|
aad, iv, ciphertext, tag []byte
|
||||||
|
original *rawJSONWebEncryption
|
||||||
|
}
|
||||||
|
|
||||||
|
// recipientInfo represents a raw JWE Per-Recipient header JSON object after parsing.
|
||||||
|
type recipientInfo struct {
|
||||||
|
header *rawHeader
|
||||||
|
encryptedKey []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAuthData retrieves the (optional) authenticated data attached to the object.
|
||||||
|
func (obj JSONWebEncryption) GetAuthData() []byte {
|
||||||
|
if obj.aad != nil {
|
||||||
|
out := make([]byte, len(obj.aad))
|
||||||
|
copy(out, obj.aad)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get the merged header values
|
||||||
|
func (obj JSONWebEncryption) mergedHeaders(recipient *recipientInfo) rawHeader {
|
||||||
|
out := rawHeader{}
|
||||||
|
out.merge(obj.protected)
|
||||||
|
out.merge(obj.unprotected)
|
||||||
|
|
||||||
|
if recipient != nil {
|
||||||
|
out.merge(recipient.header)
|
||||||
|
}
|
||||||
|
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get the additional authenticated data from a JWE object.
|
||||||
|
func (obj JSONWebEncryption) computeAuthData() []byte {
|
||||||
|
var protected string
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case obj.original != nil && obj.original.Protected != nil:
|
||||||
|
protected = obj.original.Protected.base64()
|
||||||
|
case obj.protected != nil:
|
||||||
|
protected = base64.RawURLEncoding.EncodeToString(mustSerializeJSON((obj.protected)))
|
||||||
|
default:
|
||||||
|
protected = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
output := []byte(protected)
|
||||||
|
if obj.aad != nil {
|
||||||
|
output = append(output, '.')
|
||||||
|
output = append(output, []byte(base64.RawURLEncoding.EncodeToString(obj.aad))...)
|
||||||
|
}
|
||||||
|
|
||||||
|
return output
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseEncrypted parses an encrypted message in compact or JWE JSON Serialization format.
|
||||||
|
func ParseEncrypted(input string) (*JSONWebEncryption, error) {
|
||||||
|
input = stripWhitespace(input)
|
||||||
|
if strings.HasPrefix(input, "{") {
|
||||||
|
return parseEncryptedFull(input)
|
||||||
|
}
|
||||||
|
|
||||||
|
return parseEncryptedCompact(input)
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseEncryptedFull parses a message in compact format.
|
||||||
|
func parseEncryptedFull(input string) (*JSONWebEncryption, error) {
|
||||||
|
var parsed rawJSONWebEncryption
|
||||||
|
err := json.Unmarshal([]byte(input), &parsed)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return parsed.sanitized()
|
||||||
|
}
|
||||||
|
|
||||||
|
// sanitized produces a cleaned-up JWE object from the raw JSON.
|
||||||
|
func (parsed *rawJSONWebEncryption) sanitized() (*JSONWebEncryption, error) {
|
||||||
|
obj := &JSONWebEncryption{
|
||||||
|
original: parsed,
|
||||||
|
unprotected: parsed.Unprotected,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check that there is not a nonce in the unprotected headers
|
||||||
|
if parsed.Unprotected != nil {
|
||||||
|
if nonce := parsed.Unprotected.getNonce(); nonce != "" {
|
||||||
|
return nil, ErrUnprotectedNonce
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if parsed.Header != nil {
|
||||||
|
if nonce := parsed.Header.getNonce(); nonce != "" {
|
||||||
|
return nil, ErrUnprotectedNonce
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if parsed.Protected != nil && len(parsed.Protected.bytes()) > 0 {
|
||||||
|
err := json.Unmarshal(parsed.Protected.bytes(), &obj.protected)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid protected header: %s, %s", err, parsed.Protected.base64())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Note: this must be called _after_ we parse the protected header,
|
||||||
|
// otherwise fields from the protected header will not get picked up.
|
||||||
|
var err error
|
||||||
|
mergedHeaders := obj.mergedHeaders(nil)
|
||||||
|
obj.Header, err = mergedHeaders.sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: cannot sanitize merged headers: %v (%v)", err, mergedHeaders)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(parsed.Recipients) == 0 {
|
||||||
|
obj.recipients = []recipientInfo{
|
||||||
|
{
|
||||||
|
header: parsed.Header,
|
||||||
|
encryptedKey: parsed.EncryptedKey.bytes(),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
obj.recipients = make([]recipientInfo, len(parsed.Recipients))
|
||||||
|
for r := range parsed.Recipients {
|
||||||
|
encryptedKey, err := base64URLDecode(parsed.Recipients[r].EncryptedKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check that there is not a nonce in the unprotected header
|
||||||
|
if parsed.Recipients[r].Header != nil && parsed.Recipients[r].Header.getNonce() != "" {
|
||||||
|
return nil, ErrUnprotectedNonce
|
||||||
|
}
|
||||||
|
|
||||||
|
obj.recipients[r].header = parsed.Recipients[r].Header
|
||||||
|
obj.recipients[r].encryptedKey = encryptedKey
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, recipient := range obj.recipients {
|
||||||
|
headers := obj.mergedHeaders(&recipient)
|
||||||
|
if headers.getAlgorithm() == "" || headers.getEncryption() == "" {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: message is missing alg/enc headers")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
obj.iv = parsed.Iv.bytes()
|
||||||
|
obj.ciphertext = parsed.Ciphertext.bytes()
|
||||||
|
obj.tag = parsed.Tag.bytes()
|
||||||
|
obj.aad = parsed.Aad.bytes()
|
||||||
|
|
||||||
|
return obj, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseEncryptedCompact parses a message in compact format.
|
||||||
|
func parseEncryptedCompact(input string) (*JSONWebEncryption, error) {
|
||||||
|
parts := strings.Split(input, ".")
|
||||||
|
if len(parts) != 5 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: compact JWE format must have five parts")
|
||||||
|
}
|
||||||
|
|
||||||
|
rawProtected, err := base64URLDecode(parts[0])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
encryptedKey, err := base64URLDecode(parts[1])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
iv, err := base64URLDecode(parts[2])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
ciphertext, err := base64URLDecode(parts[3])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
tag, err := base64URLDecode(parts[4])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
raw := &rawJSONWebEncryption{
|
||||||
|
Protected: newBuffer(rawProtected),
|
||||||
|
EncryptedKey: newBuffer(encryptedKey),
|
||||||
|
Iv: newBuffer(iv),
|
||||||
|
Ciphertext: newBuffer(ciphertext),
|
||||||
|
Tag: newBuffer(tag),
|
||||||
|
}
|
||||||
|
|
||||||
|
return raw.sanitized()
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompactSerialize serializes an object using the compact serialization format.
|
||||||
|
func (obj JSONWebEncryption) CompactSerialize() (string, error) {
|
||||||
|
if len(obj.recipients) != 1 || obj.unprotected != nil ||
|
||||||
|
obj.protected == nil || obj.recipients[0].header != nil {
|
||||||
|
return "", ErrNotSupported
|
||||||
|
}
|
||||||
|
|
||||||
|
serializedProtected := mustSerializeJSON(obj.protected)
|
||||||
|
|
||||||
|
return base64JoinWithDots(
|
||||||
|
serializedProtected,
|
||||||
|
obj.recipients[0].encryptedKey,
|
||||||
|
obj.iv,
|
||||||
|
obj.ciphertext,
|
||||||
|
obj.tag,
|
||||||
|
), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// FullSerialize serializes an object using the full JSON serialization format.
|
||||||
|
func (obj JSONWebEncryption) FullSerialize() string {
|
||||||
|
raw := rawJSONWebEncryption{
|
||||||
|
Unprotected: obj.unprotected,
|
||||||
|
Iv: newBuffer(obj.iv),
|
||||||
|
Ciphertext: newBuffer(obj.ciphertext),
|
||||||
|
EncryptedKey: newBuffer(obj.recipients[0].encryptedKey),
|
||||||
|
Tag: newBuffer(obj.tag),
|
||||||
|
Aad: newBuffer(obj.aad),
|
||||||
|
Recipients: []rawRecipientInfo{},
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(obj.recipients) > 1 {
|
||||||
|
for _, recipient := range obj.recipients {
|
||||||
|
info := rawRecipientInfo{
|
||||||
|
Header: recipient.header,
|
||||||
|
EncryptedKey: base64.RawURLEncoding.EncodeToString(recipient.encryptedKey),
|
||||||
|
}
|
||||||
|
raw.Recipients = append(raw.Recipients, info)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Use flattened serialization
|
||||||
|
raw.Header = obj.recipients[0].header
|
||||||
|
raw.EncryptedKey = newBuffer(obj.recipients[0].encryptedKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
if obj.protected != nil {
|
||||||
|
raw.Protected = newBuffer(mustSerializeJSON(obj.protected))
|
||||||
|
}
|
||||||
|
|
||||||
|
return string(mustSerializeJSON(raw))
|
||||||
|
}
|
|
@ -0,0 +1,812 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/ed25519"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/rsa"
|
||||||
|
"crypto/sha1"
|
||||||
|
"crypto/sha256"
|
||||||
|
"crypto/x509"
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/hex"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"math/big"
|
||||||
|
"net/url"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// rawJSONWebKey represents a public or private key in JWK format, used for parsing/serializing.
|
||||||
|
type rawJSONWebKey struct {
|
||||||
|
Use string `json:"use,omitempty"`
|
||||||
|
Kty string `json:"kty,omitempty"`
|
||||||
|
Kid string `json:"kid,omitempty"`
|
||||||
|
Crv string `json:"crv,omitempty"`
|
||||||
|
Alg string `json:"alg,omitempty"`
|
||||||
|
K *byteBuffer `json:"k,omitempty"`
|
||||||
|
X *byteBuffer `json:"x,omitempty"`
|
||||||
|
Y *byteBuffer `json:"y,omitempty"`
|
||||||
|
N *byteBuffer `json:"n,omitempty"`
|
||||||
|
E *byteBuffer `json:"e,omitempty"`
|
||||||
|
// -- Following fields are only used for private keys --
|
||||||
|
// RSA uses D, P and Q, while ECDSA uses only D. Fields Dp, Dq, and Qi are
|
||||||
|
// completely optional. Therefore for RSA/ECDSA, D != nil is a contract that
|
||||||
|
// we have a private key whereas D == nil means we have only a public key.
|
||||||
|
D *byteBuffer `json:"d,omitempty"`
|
||||||
|
P *byteBuffer `json:"p,omitempty"`
|
||||||
|
Q *byteBuffer `json:"q,omitempty"`
|
||||||
|
Dp *byteBuffer `json:"dp,omitempty"`
|
||||||
|
Dq *byteBuffer `json:"dq,omitempty"`
|
||||||
|
Qi *byteBuffer `json:"qi,omitempty"`
|
||||||
|
// Certificates
|
||||||
|
X5c []string `json:"x5c,omitempty"`
|
||||||
|
X5u string `json:"x5u,omitempty"`
|
||||||
|
X5tSHA1 string `json:"x5t,omitempty"`
|
||||||
|
X5tSHA256 string `json:"x5t#S256,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// JSONWebKey represents a public or private key in JWK format. It can be
|
||||||
|
// marshaled into JSON and unmarshaled from JSON.
|
||||||
|
type JSONWebKey struct {
|
||||||
|
// Key is the Go in-memory representation of this key. It must have one
|
||||||
|
// of these types:
|
||||||
|
// - ed25519.PublicKey
|
||||||
|
// - ed25519.PrivateKey
|
||||||
|
// - *ecdsa.PublicKey
|
||||||
|
// - *ecdsa.PrivateKey
|
||||||
|
// - *rsa.PublicKey
|
||||||
|
// - *rsa.PrivateKey
|
||||||
|
// - []byte (a symmetric key)
|
||||||
|
//
|
||||||
|
// When marshaling this JSONWebKey into JSON, the "kty" header parameter
|
||||||
|
// will be automatically set based on the type of this field.
|
||||||
|
Key interface{}
|
||||||
|
// Key identifier, parsed from `kid` header.
|
||||||
|
KeyID string
|
||||||
|
// Key algorithm, parsed from `alg` header.
|
||||||
|
Algorithm string
|
||||||
|
// Key use, parsed from `use` header.
|
||||||
|
Use string
|
||||||
|
|
||||||
|
// X.509 certificate chain, parsed from `x5c` header.
|
||||||
|
Certificates []*x509.Certificate
|
||||||
|
// X.509 certificate URL, parsed from `x5u` header.
|
||||||
|
CertificatesURL *url.URL
|
||||||
|
// X.509 certificate thumbprint (SHA-1), parsed from `x5t` header.
|
||||||
|
CertificateThumbprintSHA1 []byte
|
||||||
|
// X.509 certificate thumbprint (SHA-256), parsed from `x5t#S256` header.
|
||||||
|
CertificateThumbprintSHA256 []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON serializes the given key to its JSON representation.
|
||||||
|
func (k JSONWebKey) MarshalJSON() ([]byte, error) {
|
||||||
|
var raw *rawJSONWebKey
|
||||||
|
var err error
|
||||||
|
|
||||||
|
switch key := k.Key.(type) {
|
||||||
|
case ed25519.PublicKey:
|
||||||
|
raw = fromEdPublicKey(key)
|
||||||
|
case *ecdsa.PublicKey:
|
||||||
|
raw, err = fromEcPublicKey(key)
|
||||||
|
case *rsa.PublicKey:
|
||||||
|
raw = fromRsaPublicKey(key)
|
||||||
|
case ed25519.PrivateKey:
|
||||||
|
raw, err = fromEdPrivateKey(key)
|
||||||
|
case *ecdsa.PrivateKey:
|
||||||
|
raw, err = fromEcPrivateKey(key)
|
||||||
|
case *rsa.PrivateKey:
|
||||||
|
raw, err = fromRsaPrivateKey(key)
|
||||||
|
case []byte:
|
||||||
|
raw, err = fromSymmetricKey(key)
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: unknown key type '%s'", reflect.TypeOf(key))
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
raw.Kid = k.KeyID
|
||||||
|
raw.Alg = k.Algorithm
|
||||||
|
raw.Use = k.Use
|
||||||
|
|
||||||
|
for _, cert := range k.Certificates {
|
||||||
|
raw.X5c = append(raw.X5c, base64.StdEncoding.EncodeToString(cert.Raw))
|
||||||
|
}
|
||||||
|
|
||||||
|
x5tSHA1Len := len(k.CertificateThumbprintSHA1)
|
||||||
|
x5tSHA256Len := len(k.CertificateThumbprintSHA256)
|
||||||
|
if x5tSHA1Len > 0 {
|
||||||
|
if x5tSHA1Len != sha1.Size {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid SHA-1 thumbprint (must be %d bytes, not %d)", sha1.Size, x5tSHA1Len)
|
||||||
|
}
|
||||||
|
raw.X5tSHA1 = base64.RawURLEncoding.EncodeToString(k.CertificateThumbprintSHA1)
|
||||||
|
}
|
||||||
|
if x5tSHA256Len > 0 {
|
||||||
|
if x5tSHA256Len != sha256.Size {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid SHA-256 thumbprint (must be %d bytes, not %d)", sha256.Size, x5tSHA256Len)
|
||||||
|
}
|
||||||
|
raw.X5tSHA256 = base64.RawURLEncoding.EncodeToString(k.CertificateThumbprintSHA256)
|
||||||
|
}
|
||||||
|
|
||||||
|
// If cert chain is attached (as opposed to being behind a URL), check the
|
||||||
|
// keys thumbprints to make sure they match what is expected. This is to
|
||||||
|
// ensure we don't accidentally produce a JWK with semantically inconsistent
|
||||||
|
// data in the headers.
|
||||||
|
if len(k.Certificates) > 0 {
|
||||||
|
expectedSHA1 := sha1.Sum(k.Certificates[0].Raw)
|
||||||
|
expectedSHA256 := sha256.Sum256(k.Certificates[0].Raw)
|
||||||
|
|
||||||
|
if len(k.CertificateThumbprintSHA1) > 0 && !bytes.Equal(k.CertificateThumbprintSHA1, expectedSHA1[:]) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid SHA-1 thumbprint, does not match cert chain")
|
||||||
|
}
|
||||||
|
if len(k.CertificateThumbprintSHA256) > 0 && !bytes.Equal(k.CertificateThumbprintSHA256, expectedSHA256[:]) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid or SHA-256 thumbprint, does not match cert chain")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if k.CertificatesURL != nil {
|
||||||
|
raw.X5u = k.CertificatesURL.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
return json.Marshal(raw)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON reads a key from its JSON representation.
|
||||||
|
func (k *JSONWebKey) UnmarshalJSON(data []byte) (err error) {
|
||||||
|
var raw rawJSONWebKey
|
||||||
|
err = json.Unmarshal(data, &raw)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
certs, err := parseCertificateChain(raw.X5c)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("go-jose/go-jose: failed to unmarshal x5c field: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var key interface{}
|
||||||
|
var certPub interface{}
|
||||||
|
var keyPub interface{}
|
||||||
|
|
||||||
|
if len(certs) > 0 {
|
||||||
|
// We need to check that leaf public key matches the key embedded in this
|
||||||
|
// JWK, as required by the standard (see RFC 7517, Section 4.7). Otherwise
|
||||||
|
// the JWK parsed could be semantically invalid. Technically, should also
|
||||||
|
// check key usage fields and other extensions on the cert here, but the
|
||||||
|
// standard doesn't exactly explain how they're supposed to map from the
|
||||||
|
// JWK representation to the X.509 extensions.
|
||||||
|
certPub = certs[0].PublicKey
|
||||||
|
}
|
||||||
|
|
||||||
|
switch raw.Kty {
|
||||||
|
case "EC":
|
||||||
|
if raw.D != nil {
|
||||||
|
key, err = raw.ecPrivateKey()
|
||||||
|
if err == nil {
|
||||||
|
keyPub = key.(*ecdsa.PrivateKey).Public()
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
key, err = raw.ecPublicKey()
|
||||||
|
keyPub = key
|
||||||
|
}
|
||||||
|
case "RSA":
|
||||||
|
if raw.D != nil {
|
||||||
|
key, err = raw.rsaPrivateKey()
|
||||||
|
if err == nil {
|
||||||
|
keyPub = key.(*rsa.PrivateKey).Public()
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
key, err = raw.rsaPublicKey()
|
||||||
|
keyPub = key
|
||||||
|
}
|
||||||
|
case "oct":
|
||||||
|
if certPub != nil {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, found 'oct' (symmetric) key with cert chain")
|
||||||
|
}
|
||||||
|
key, err = raw.symmetricKey()
|
||||||
|
case "OKP":
|
||||||
|
if raw.Crv == "Ed25519" && raw.X != nil {
|
||||||
|
if raw.D != nil {
|
||||||
|
key, err = raw.edPrivateKey()
|
||||||
|
if err == nil {
|
||||||
|
keyPub = key.(ed25519.PrivateKey).Public()
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
key, err = raw.edPublicKey()
|
||||||
|
keyPub = key
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
err = fmt.Errorf("go-jose/go-jose: unknown curve %s'", raw.Crv)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
err = fmt.Errorf("go-jose/go-jose: unknown json web key type '%s'", raw.Kty)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if certPub != nil && keyPub != nil {
|
||||||
|
if !reflect.DeepEqual(certPub, keyPub) {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, public keys in key and x5c fields do not match")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
*k = JSONWebKey{Key: key, KeyID: raw.Kid, Algorithm: raw.Alg, Use: raw.Use, Certificates: certs}
|
||||||
|
|
||||||
|
if raw.X5u != "" {
|
||||||
|
k.CertificatesURL, err = url.Parse(raw.X5u)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("go-jose/go-jose: invalid JWK, x5u header is invalid URL: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// x5t parameters are base64url-encoded SHA thumbprints
|
||||||
|
// See RFC 7517, Section 4.8, https://tools.ietf.org/html/rfc7517#section-4.8
|
||||||
|
x5tSHA1bytes, err := base64URLDecode(raw.X5tSHA1)
|
||||||
|
if err != nil {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, x5t header has invalid encoding")
|
||||||
|
}
|
||||||
|
|
||||||
|
// RFC 7517, Section 4.8 is ambiguous as to whether the digest output should be byte or hex,
|
||||||
|
// for this reason, after base64 decoding, if the size is sha1.Size it's likely that the value is a byte encoded
|
||||||
|
// checksum so we skip this. Otherwise if the checksum was hex encoded we expect a 40 byte sized array so we'll
|
||||||
|
// try to hex decode it. When Marshalling this value we'll always use a base64 encoded version of byte format checksum.
|
||||||
|
if len(x5tSHA1bytes) == 2*sha1.Size {
|
||||||
|
hx, err := hex.DecodeString(string(x5tSHA1bytes))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("go-jose/go-jose: invalid JWK, unable to hex decode x5t: %v", err)
|
||||||
|
|
||||||
|
}
|
||||||
|
x5tSHA1bytes = hx
|
||||||
|
}
|
||||||
|
|
||||||
|
k.CertificateThumbprintSHA1 = x5tSHA1bytes
|
||||||
|
|
||||||
|
x5tSHA256bytes, err := base64URLDecode(raw.X5tSHA256)
|
||||||
|
if err != nil {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, x5t#S256 header has invalid encoding")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(x5tSHA256bytes) == 2*sha256.Size {
|
||||||
|
hx256, err := hex.DecodeString(string(x5tSHA256bytes))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("go-jose/go-jose: invalid JWK, unable to hex decode x5t#S256: %v", err)
|
||||||
|
}
|
||||||
|
x5tSHA256bytes = hx256
|
||||||
|
}
|
||||||
|
|
||||||
|
k.CertificateThumbprintSHA256 = x5tSHA256bytes
|
||||||
|
|
||||||
|
x5tSHA1Len := len(k.CertificateThumbprintSHA1)
|
||||||
|
x5tSHA256Len := len(k.CertificateThumbprintSHA256)
|
||||||
|
if x5tSHA1Len > 0 && x5tSHA1Len != sha1.Size {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, x5t header is of incorrect size")
|
||||||
|
}
|
||||||
|
if x5tSHA256Len > 0 && x5tSHA256Len != sha256.Size {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, x5t#S256 header is of incorrect size")
|
||||||
|
}
|
||||||
|
|
||||||
|
// If certificate chain *and* thumbprints are set, verify correctness.
|
||||||
|
if len(k.Certificates) > 0 {
|
||||||
|
leaf := k.Certificates[0]
|
||||||
|
sha1sum := sha1.Sum(leaf.Raw)
|
||||||
|
sha256sum := sha256.Sum256(leaf.Raw)
|
||||||
|
|
||||||
|
if len(k.CertificateThumbprintSHA1) > 0 && !bytes.Equal(sha1sum[:], k.CertificateThumbprintSHA1) {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, x5c thumbprint does not match x5t value")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(k.CertificateThumbprintSHA256) > 0 && !bytes.Equal(sha256sum[:], k.CertificateThumbprintSHA256) {
|
||||||
|
return errors.New("go-jose/go-jose: invalid JWK, x5c thumbprint does not match x5t#S256 value")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// JSONWebKeySet represents a JWK Set object.
|
||||||
|
type JSONWebKeySet struct {
|
||||||
|
Keys []JSONWebKey `json:"keys"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Key convenience method returns keys by key ID. Specification states
|
||||||
|
// that a JWK Set "SHOULD" use distinct key IDs, but allows for some
|
||||||
|
// cases where they are not distinct. Hence method returns a slice
|
||||||
|
// of JSONWebKeys.
|
||||||
|
func (s *JSONWebKeySet) Key(kid string) []JSONWebKey {
|
||||||
|
var keys []JSONWebKey
|
||||||
|
for _, key := range s.Keys {
|
||||||
|
if key.KeyID == kid {
|
||||||
|
keys = append(keys, key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return keys
|
||||||
|
}
|
||||||
|
|
||||||
|
const rsaThumbprintTemplate = `{"e":"%s","kty":"RSA","n":"%s"}`
|
||||||
|
const ecThumbprintTemplate = `{"crv":"%s","kty":"EC","x":"%s","y":"%s"}`
|
||||||
|
const edThumbprintTemplate = `{"crv":"%s","kty":"OKP","x":"%s"}`
|
||||||
|
|
||||||
|
func ecThumbprintInput(curve elliptic.Curve, x, y *big.Int) (string, error) {
|
||||||
|
coordLength := curveSize(curve)
|
||||||
|
crv, err := curveName(curve)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(x.Bytes()) > coordLength || len(y.Bytes()) > coordLength {
|
||||||
|
return "", errors.New("go-jose/go-jose: invalid elliptic key (too large)")
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(ecThumbprintTemplate, crv,
|
||||||
|
newFixedSizeBuffer(x.Bytes(), coordLength).base64(),
|
||||||
|
newFixedSizeBuffer(y.Bytes(), coordLength).base64()), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func rsaThumbprintInput(n *big.Int, e int) (string, error) {
|
||||||
|
return fmt.Sprintf(rsaThumbprintTemplate,
|
||||||
|
newBufferFromInt(uint64(e)).base64(),
|
||||||
|
newBuffer(n.Bytes()).base64()), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func edThumbprintInput(ed ed25519.PublicKey) (string, error) {
|
||||||
|
crv := "Ed25519"
|
||||||
|
if len(ed) > 32 {
|
||||||
|
return "", errors.New("go-jose/go-jose: invalid elliptic key (too large)")
|
||||||
|
}
|
||||||
|
return fmt.Sprintf(edThumbprintTemplate, crv,
|
||||||
|
newFixedSizeBuffer(ed, 32).base64()), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Thumbprint computes the JWK Thumbprint of a key using the
|
||||||
|
// indicated hash algorithm.
|
||||||
|
func (k *JSONWebKey) Thumbprint(hash crypto.Hash) ([]byte, error) {
|
||||||
|
var input string
|
||||||
|
var err error
|
||||||
|
switch key := k.Key.(type) {
|
||||||
|
case ed25519.PublicKey:
|
||||||
|
input, err = edThumbprintInput(key)
|
||||||
|
case *ecdsa.PublicKey:
|
||||||
|
input, err = ecThumbprintInput(key.Curve, key.X, key.Y)
|
||||||
|
case *ecdsa.PrivateKey:
|
||||||
|
input, err = ecThumbprintInput(key.Curve, key.X, key.Y)
|
||||||
|
case *rsa.PublicKey:
|
||||||
|
input, err = rsaThumbprintInput(key.N, key.E)
|
||||||
|
case *rsa.PrivateKey:
|
||||||
|
input, err = rsaThumbprintInput(key.N, key.E)
|
||||||
|
case ed25519.PrivateKey:
|
||||||
|
input, err = edThumbprintInput(ed25519.PublicKey(key[32:]))
|
||||||
|
case OpaqueSigner:
|
||||||
|
return key.Public().Thumbprint(hash)
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: unknown key type '%s'", reflect.TypeOf(key))
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
h := hash.New()
|
||||||
|
_, _ = h.Write([]byte(input))
|
||||||
|
return h.Sum(nil), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsPublic returns true if the JWK represents a public key (not symmetric, not private).
|
||||||
|
func (k *JSONWebKey) IsPublic() bool {
|
||||||
|
switch k.Key.(type) {
|
||||||
|
case *ecdsa.PublicKey, *rsa.PublicKey, ed25519.PublicKey:
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Public creates JSONWebKey with corresponding public key if JWK represents asymmetric private key.
|
||||||
|
func (k *JSONWebKey) Public() JSONWebKey {
|
||||||
|
if k.IsPublic() {
|
||||||
|
return *k
|
||||||
|
}
|
||||||
|
ret := *k
|
||||||
|
switch key := k.Key.(type) {
|
||||||
|
case *ecdsa.PrivateKey:
|
||||||
|
ret.Key = key.Public()
|
||||||
|
case *rsa.PrivateKey:
|
||||||
|
ret.Key = key.Public()
|
||||||
|
case ed25519.PrivateKey:
|
||||||
|
ret.Key = key.Public()
|
||||||
|
default:
|
||||||
|
return JSONWebKey{} // returning invalid key
|
||||||
|
}
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|
||||||
|
// Valid checks that the key contains the expected parameters.
|
||||||
|
func (k *JSONWebKey) Valid() bool {
|
||||||
|
if k.Key == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
switch key := k.Key.(type) {
|
||||||
|
case *ecdsa.PublicKey:
|
||||||
|
if key.Curve == nil || key.X == nil || key.Y == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
case *ecdsa.PrivateKey:
|
||||||
|
if key.Curve == nil || key.X == nil || key.Y == nil || key.D == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
case *rsa.PublicKey:
|
||||||
|
if key.N == nil || key.E == 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
case *rsa.PrivateKey:
|
||||||
|
if key.N == nil || key.E == 0 || key.D == nil || len(key.Primes) < 2 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
case ed25519.PublicKey:
|
||||||
|
if len(key) != 32 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
case ed25519.PrivateKey:
|
||||||
|
if len(key) != 64 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (key rawJSONWebKey) rsaPublicKey() (*rsa.PublicKey, error) {
|
||||||
|
if key.N == nil || key.E == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid RSA key, missing n/e values")
|
||||||
|
}
|
||||||
|
|
||||||
|
return &rsa.PublicKey{
|
||||||
|
N: key.N.bigInt(),
|
||||||
|
E: key.E.toInt(),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromEdPublicKey(pub ed25519.PublicKey) *rawJSONWebKey {
|
||||||
|
return &rawJSONWebKey{
|
||||||
|
Kty: "OKP",
|
||||||
|
Crv: "Ed25519",
|
||||||
|
X: newBuffer(pub),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromRsaPublicKey(pub *rsa.PublicKey) *rawJSONWebKey {
|
||||||
|
return &rawJSONWebKey{
|
||||||
|
Kty: "RSA",
|
||||||
|
N: newBuffer(pub.N.Bytes()),
|
||||||
|
E: newBufferFromInt(uint64(pub.E)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (key rawJSONWebKey) ecPublicKey() (*ecdsa.PublicKey, error) {
|
||||||
|
var curve elliptic.Curve
|
||||||
|
switch key.Crv {
|
||||||
|
case "P-256":
|
||||||
|
curve = elliptic.P256()
|
||||||
|
case "P-384":
|
||||||
|
curve = elliptic.P384()
|
||||||
|
case "P-521":
|
||||||
|
curve = elliptic.P521()
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: unsupported elliptic curve '%s'", key.Crv)
|
||||||
|
}
|
||||||
|
|
||||||
|
if key.X == nil || key.Y == nil {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid EC key, missing x/y values")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The length of this octet string MUST be the full size of a coordinate for
|
||||||
|
// the curve specified in the "crv" parameter.
|
||||||
|
// https://tools.ietf.org/html/rfc7518#section-6.2.1.2
|
||||||
|
if curveSize(curve) != len(key.X.data) {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC public key, wrong length for x")
|
||||||
|
}
|
||||||
|
|
||||||
|
if curveSize(curve) != len(key.Y.data) {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC public key, wrong length for y")
|
||||||
|
}
|
||||||
|
|
||||||
|
x := key.X.bigInt()
|
||||||
|
y := key.Y.bigInt()
|
||||||
|
|
||||||
|
if !curve.IsOnCurve(x, y) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid EC key, X/Y are not on declared curve")
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ecdsa.PublicKey{
|
||||||
|
Curve: curve,
|
||||||
|
X: x,
|
||||||
|
Y: y,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromEcPublicKey(pub *ecdsa.PublicKey) (*rawJSONWebKey, error) {
|
||||||
|
if pub == nil || pub.X == nil || pub.Y == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC key (nil, or X/Y missing)")
|
||||||
|
}
|
||||||
|
|
||||||
|
name, err := curveName(pub.Curve)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
size := curveSize(pub.Curve)
|
||||||
|
|
||||||
|
xBytes := pub.X.Bytes()
|
||||||
|
yBytes := pub.Y.Bytes()
|
||||||
|
|
||||||
|
if len(xBytes) > size || len(yBytes) > size {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC key (X/Y too large)")
|
||||||
|
}
|
||||||
|
|
||||||
|
key := &rawJSONWebKey{
|
||||||
|
Kty: "EC",
|
||||||
|
Crv: name,
|
||||||
|
X: newFixedSizeBuffer(xBytes, size),
|
||||||
|
Y: newFixedSizeBuffer(yBytes, size),
|
||||||
|
}
|
||||||
|
|
||||||
|
return key, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (key rawJSONWebKey) edPrivateKey() (ed25519.PrivateKey, error) {
|
||||||
|
var missing []string
|
||||||
|
switch {
|
||||||
|
case key.D == nil:
|
||||||
|
missing = append(missing, "D")
|
||||||
|
case key.X == nil:
|
||||||
|
missing = append(missing, "X")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(missing) > 0 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid Ed25519 private key, missing %s value(s)", strings.Join(missing, ", "))
|
||||||
|
}
|
||||||
|
|
||||||
|
privateKey := make([]byte, ed25519.PrivateKeySize)
|
||||||
|
copy(privateKey[0:32], key.D.bytes())
|
||||||
|
copy(privateKey[32:], key.X.bytes())
|
||||||
|
rv := ed25519.PrivateKey(privateKey)
|
||||||
|
return rv, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (key rawJSONWebKey) edPublicKey() (ed25519.PublicKey, error) {
|
||||||
|
if key.X == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid Ed key, missing x value")
|
||||||
|
}
|
||||||
|
publicKey := make([]byte, ed25519.PublicKeySize)
|
||||||
|
copy(publicKey[0:32], key.X.bytes())
|
||||||
|
rv := ed25519.PublicKey(publicKey)
|
||||||
|
return rv, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (key rawJSONWebKey) rsaPrivateKey() (*rsa.PrivateKey, error) {
|
||||||
|
var missing []string
|
||||||
|
switch {
|
||||||
|
case key.N == nil:
|
||||||
|
missing = append(missing, "N")
|
||||||
|
case key.E == nil:
|
||||||
|
missing = append(missing, "E")
|
||||||
|
case key.D == nil:
|
||||||
|
missing = append(missing, "D")
|
||||||
|
case key.P == nil:
|
||||||
|
missing = append(missing, "P")
|
||||||
|
case key.Q == nil:
|
||||||
|
missing = append(missing, "Q")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(missing) > 0 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid RSA private key, missing %s value(s)", strings.Join(missing, ", "))
|
||||||
|
}
|
||||||
|
|
||||||
|
rv := &rsa.PrivateKey{
|
||||||
|
PublicKey: rsa.PublicKey{
|
||||||
|
N: key.N.bigInt(),
|
||||||
|
E: key.E.toInt(),
|
||||||
|
},
|
||||||
|
D: key.D.bigInt(),
|
||||||
|
Primes: []*big.Int{
|
||||||
|
key.P.bigInt(),
|
||||||
|
key.Q.bigInt(),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
if key.Dp != nil {
|
||||||
|
rv.Precomputed.Dp = key.Dp.bigInt()
|
||||||
|
}
|
||||||
|
if key.Dq != nil {
|
||||||
|
rv.Precomputed.Dq = key.Dq.bigInt()
|
||||||
|
}
|
||||||
|
if key.Qi != nil {
|
||||||
|
rv.Precomputed.Qinv = key.Qi.bigInt()
|
||||||
|
}
|
||||||
|
|
||||||
|
err := rv.Validate()
|
||||||
|
return rv, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromEdPrivateKey(ed ed25519.PrivateKey) (*rawJSONWebKey, error) {
|
||||||
|
raw := fromEdPublicKey(ed25519.PublicKey(ed[32:]))
|
||||||
|
|
||||||
|
raw.D = newBuffer(ed[0:32])
|
||||||
|
return raw, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromRsaPrivateKey(rsa *rsa.PrivateKey) (*rawJSONWebKey, error) {
|
||||||
|
if len(rsa.Primes) != 2 {
|
||||||
|
return nil, ErrUnsupportedKeyType
|
||||||
|
}
|
||||||
|
|
||||||
|
raw := fromRsaPublicKey(&rsa.PublicKey)
|
||||||
|
|
||||||
|
raw.D = newBuffer(rsa.D.Bytes())
|
||||||
|
raw.P = newBuffer(rsa.Primes[0].Bytes())
|
||||||
|
raw.Q = newBuffer(rsa.Primes[1].Bytes())
|
||||||
|
|
||||||
|
if rsa.Precomputed.Dp != nil {
|
||||||
|
raw.Dp = newBuffer(rsa.Precomputed.Dp.Bytes())
|
||||||
|
}
|
||||||
|
if rsa.Precomputed.Dq != nil {
|
||||||
|
raw.Dq = newBuffer(rsa.Precomputed.Dq.Bytes())
|
||||||
|
}
|
||||||
|
if rsa.Precomputed.Qinv != nil {
|
||||||
|
raw.Qi = newBuffer(rsa.Precomputed.Qinv.Bytes())
|
||||||
|
}
|
||||||
|
|
||||||
|
return raw, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (key rawJSONWebKey) ecPrivateKey() (*ecdsa.PrivateKey, error) {
|
||||||
|
var curve elliptic.Curve
|
||||||
|
switch key.Crv {
|
||||||
|
case "P-256":
|
||||||
|
curve = elliptic.P256()
|
||||||
|
case "P-384":
|
||||||
|
curve = elliptic.P384()
|
||||||
|
case "P-521":
|
||||||
|
curve = elliptic.P521()
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: unsupported elliptic curve '%s'", key.Crv)
|
||||||
|
}
|
||||||
|
|
||||||
|
if key.X == nil || key.Y == nil || key.D == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC private key, missing x/y/d values")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The length of this octet string MUST be the full size of a coordinate for
|
||||||
|
// the curve specified in the "crv" parameter.
|
||||||
|
// https://tools.ietf.org/html/rfc7518#section-6.2.1.2
|
||||||
|
if curveSize(curve) != len(key.X.data) {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC private key, wrong length for x")
|
||||||
|
}
|
||||||
|
|
||||||
|
if curveSize(curve) != len(key.Y.data) {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC private key, wrong length for y")
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://tools.ietf.org/html/rfc7518#section-6.2.2.1
|
||||||
|
if dSize(curve) != len(key.D.data) {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC private key, wrong length for d")
|
||||||
|
}
|
||||||
|
|
||||||
|
x := key.X.bigInt()
|
||||||
|
y := key.Y.bigInt()
|
||||||
|
|
||||||
|
if !curve.IsOnCurve(x, y) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid EC key, X/Y are not on declared curve")
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ecdsa.PrivateKey{
|
||||||
|
PublicKey: ecdsa.PublicKey{
|
||||||
|
Curve: curve,
|
||||||
|
X: x,
|
||||||
|
Y: y,
|
||||||
|
},
|
||||||
|
D: key.D.bigInt(),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromEcPrivateKey(ec *ecdsa.PrivateKey) (*rawJSONWebKey, error) {
|
||||||
|
raw, err := fromEcPublicKey(&ec.PublicKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if ec.D == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid EC private key")
|
||||||
|
}
|
||||||
|
|
||||||
|
raw.D = newFixedSizeBuffer(ec.D.Bytes(), dSize(ec.PublicKey.Curve))
|
||||||
|
|
||||||
|
return raw, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// dSize returns the size in octets for the "d" member of an elliptic curve
|
||||||
|
// private key.
|
||||||
|
// The length of this octet string MUST be ceiling(log-base-2(n)/8)
|
||||||
|
// octets (where n is the order of the curve).
|
||||||
|
// https://tools.ietf.org/html/rfc7518#section-6.2.2.1
|
||||||
|
func dSize(curve elliptic.Curve) int {
|
||||||
|
order := curve.Params().P
|
||||||
|
bitLen := order.BitLen()
|
||||||
|
size := bitLen / 8
|
||||||
|
if bitLen%8 != 0 {
|
||||||
|
size++
|
||||||
|
}
|
||||||
|
return size
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromSymmetricKey(key []byte) (*rawJSONWebKey, error) {
|
||||||
|
return &rawJSONWebKey{
|
||||||
|
Kty: "oct",
|
||||||
|
K: newBuffer(key),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (key rawJSONWebKey) symmetricKey() ([]byte, error) {
|
||||||
|
if key.K == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid OCT (symmetric) key, missing k value")
|
||||||
|
}
|
||||||
|
return key.K.bytes(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func tryJWKS(key interface{}, headers ...Header) interface{} {
|
||||||
|
var jwks JSONWebKeySet
|
||||||
|
|
||||||
|
switch jwksType := key.(type) {
|
||||||
|
case *JSONWebKeySet:
|
||||||
|
jwks = *jwksType
|
||||||
|
case JSONWebKeySet:
|
||||||
|
jwks = jwksType
|
||||||
|
default:
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
|
||||||
|
var kid string
|
||||||
|
for _, header := range headers {
|
||||||
|
if header.KeyID != "" {
|
||||||
|
kid = header.KeyID
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if kid == "" {
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
|
||||||
|
keys := jwks.Key(kid)
|
||||||
|
if len(keys) == 0 {
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
|
||||||
|
return keys[0].Key
|
||||||
|
}
|
|
@ -0,0 +1,369 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/base64"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// rawJSONWebSignature represents a raw JWS JSON object. Used for parsing/serializing.
|
||||||
|
type rawJSONWebSignature struct {
|
||||||
|
Payload *byteBuffer `json:"payload,omitempty"`
|
||||||
|
Signatures []rawSignatureInfo `json:"signatures,omitempty"`
|
||||||
|
Protected *byteBuffer `json:"protected,omitempty"`
|
||||||
|
Header *rawHeader `json:"header,omitempty"`
|
||||||
|
Signature *byteBuffer `json:"signature,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// rawSignatureInfo represents a single JWS signature over the JWS payload and protected header.
|
||||||
|
type rawSignatureInfo struct {
|
||||||
|
Protected *byteBuffer `json:"protected,omitempty"`
|
||||||
|
Header *rawHeader `json:"header,omitempty"`
|
||||||
|
Signature *byteBuffer `json:"signature,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// JSONWebSignature represents a signed JWS object after parsing.
|
||||||
|
type JSONWebSignature struct {
|
||||||
|
payload []byte
|
||||||
|
// Signatures attached to this object (may be more than one for multi-sig).
|
||||||
|
// Be careful about accessing these directly, prefer to use Verify() or
|
||||||
|
// VerifyMulti() to ensure that the data you're getting is verified.
|
||||||
|
Signatures []Signature
|
||||||
|
}
|
||||||
|
|
||||||
|
// Signature represents a single signature over the JWS payload and protected header.
|
||||||
|
type Signature struct {
|
||||||
|
// Merged header fields. Contains both protected and unprotected header
|
||||||
|
// values. Prefer using Protected and Unprotected fields instead of this.
|
||||||
|
// Values in this header may or may not have been signed and in general
|
||||||
|
// should not be trusted.
|
||||||
|
Header Header
|
||||||
|
|
||||||
|
// Protected header. Values in this header were signed and
|
||||||
|
// will be verified as part of the signature verification process.
|
||||||
|
Protected Header
|
||||||
|
|
||||||
|
// Unprotected header. Values in this header were not signed
|
||||||
|
// and in general should not be trusted.
|
||||||
|
Unprotected Header
|
||||||
|
|
||||||
|
// The actual signature value
|
||||||
|
Signature []byte
|
||||||
|
|
||||||
|
protected *rawHeader
|
||||||
|
header *rawHeader
|
||||||
|
original *rawSignatureInfo
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseSigned parses a signed message in compact or JWS JSON Serialization format.
|
||||||
|
func ParseSigned(signature string) (*JSONWebSignature, error) {
|
||||||
|
signature = stripWhitespace(signature)
|
||||||
|
if strings.HasPrefix(signature, "{") {
|
||||||
|
return parseSignedFull(signature)
|
||||||
|
}
|
||||||
|
|
||||||
|
return parseSignedCompact(signature, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseDetached parses a signed message in compact serialization format with detached payload.
|
||||||
|
func ParseDetached(signature string, payload []byte) (*JSONWebSignature, error) {
|
||||||
|
if payload == nil {
|
||||||
|
return nil, errors.New("go-jose/go-jose: nil payload")
|
||||||
|
}
|
||||||
|
return parseSignedCompact(stripWhitespace(signature), payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get a header value
|
||||||
|
func (sig Signature) mergedHeaders() rawHeader {
|
||||||
|
out := rawHeader{}
|
||||||
|
out.merge(sig.protected)
|
||||||
|
out.merge(sig.header)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compute data to be signed
|
||||||
|
func (obj JSONWebSignature) computeAuthData(payload []byte, signature *Signature) ([]byte, error) {
|
||||||
|
var authData bytes.Buffer
|
||||||
|
|
||||||
|
protectedHeader := new(rawHeader)
|
||||||
|
|
||||||
|
if signature.original != nil && signature.original.Protected != nil {
|
||||||
|
if err := json.Unmarshal(signature.original.Protected.bytes(), protectedHeader); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
authData.WriteString(signature.original.Protected.base64())
|
||||||
|
} else if signature.protected != nil {
|
||||||
|
protectedHeader = signature.protected
|
||||||
|
authData.WriteString(base64.RawURLEncoding.EncodeToString(mustSerializeJSON(protectedHeader)))
|
||||||
|
}
|
||||||
|
|
||||||
|
needsBase64 := true
|
||||||
|
|
||||||
|
if protectedHeader != nil {
|
||||||
|
var err error
|
||||||
|
if needsBase64, err = protectedHeader.getB64(); err != nil {
|
||||||
|
needsBase64 = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
authData.WriteByte('.')
|
||||||
|
|
||||||
|
if needsBase64 {
|
||||||
|
authData.WriteString(base64.RawURLEncoding.EncodeToString(payload))
|
||||||
|
} else {
|
||||||
|
authData.Write(payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
return authData.Bytes(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseSignedFull parses a message in full format.
|
||||||
|
func parseSignedFull(input string) (*JSONWebSignature, error) {
|
||||||
|
var parsed rawJSONWebSignature
|
||||||
|
err := json.Unmarshal([]byte(input), &parsed)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return parsed.sanitized()
|
||||||
|
}
|
||||||
|
|
||||||
|
// sanitized produces a cleaned-up JWS object from the raw JSON.
|
||||||
|
func (parsed *rawJSONWebSignature) sanitized() (*JSONWebSignature, error) {
|
||||||
|
if parsed.Payload == nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: missing payload in JWS message")
|
||||||
|
}
|
||||||
|
|
||||||
|
obj := &JSONWebSignature{
|
||||||
|
payload: parsed.Payload.bytes(),
|
||||||
|
Signatures: make([]Signature, len(parsed.Signatures)),
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(parsed.Signatures) == 0 {
|
||||||
|
// No signatures array, must be flattened serialization
|
||||||
|
signature := Signature{}
|
||||||
|
if parsed.Protected != nil && len(parsed.Protected.bytes()) > 0 {
|
||||||
|
signature.protected = &rawHeader{}
|
||||||
|
err := json.Unmarshal(parsed.Protected.bytes(), signature.protected)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check that there is not a nonce in the unprotected header
|
||||||
|
if parsed.Header != nil && parsed.Header.getNonce() != "" {
|
||||||
|
return nil, ErrUnprotectedNonce
|
||||||
|
}
|
||||||
|
|
||||||
|
signature.header = parsed.Header
|
||||||
|
signature.Signature = parsed.Signature.bytes()
|
||||||
|
// Make a fake "original" rawSignatureInfo to store the unprocessed
|
||||||
|
// Protected header. This is necessary because the Protected header can
|
||||||
|
// contain arbitrary fields not registered as part of the spec. See
|
||||||
|
// https://tools.ietf.org/html/draft-ietf-jose-json-web-signature-41#section-4
|
||||||
|
// If we unmarshal Protected into a rawHeader with its explicit list of fields,
|
||||||
|
// we cannot marshal losslessly. So we have to keep around the original bytes.
|
||||||
|
// This is used in computeAuthData, which will first attempt to use
|
||||||
|
// the original bytes of a protected header, and fall back on marshaling the
|
||||||
|
// header struct only if those bytes are not available.
|
||||||
|
signature.original = &rawSignatureInfo{
|
||||||
|
Protected: parsed.Protected,
|
||||||
|
Header: parsed.Header,
|
||||||
|
Signature: parsed.Signature,
|
||||||
|
}
|
||||||
|
|
||||||
|
var err error
|
||||||
|
signature.Header, err = signature.mergedHeaders().sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if signature.header != nil {
|
||||||
|
signature.Unprotected, err = signature.header.sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if signature.protected != nil {
|
||||||
|
signature.Protected, err = signature.protected.sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// As per RFC 7515 Section 4.1.3, only public keys are allowed to be embedded.
|
||||||
|
jwk := signature.Header.JSONWebKey
|
||||||
|
if jwk != nil && (!jwk.Valid() || !jwk.IsPublic()) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid embedded jwk, must be public key")
|
||||||
|
}
|
||||||
|
|
||||||
|
obj.Signatures = append(obj.Signatures, signature)
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, sig := range parsed.Signatures {
|
||||||
|
if sig.Protected != nil && len(sig.Protected.bytes()) > 0 {
|
||||||
|
obj.Signatures[i].protected = &rawHeader{}
|
||||||
|
err := json.Unmarshal(sig.Protected.bytes(), obj.Signatures[i].protected)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check that there is not a nonce in the unprotected header
|
||||||
|
if sig.Header != nil && sig.Header.getNonce() != "" {
|
||||||
|
return nil, ErrUnprotectedNonce
|
||||||
|
}
|
||||||
|
|
||||||
|
var err error
|
||||||
|
obj.Signatures[i].Header, err = obj.Signatures[i].mergedHeaders().sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if obj.Signatures[i].header != nil {
|
||||||
|
obj.Signatures[i].Unprotected, err = obj.Signatures[i].header.sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if obj.Signatures[i].protected != nil {
|
||||||
|
obj.Signatures[i].Protected, err = obj.Signatures[i].protected.sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
obj.Signatures[i].Signature = sig.Signature.bytes()
|
||||||
|
|
||||||
|
// As per RFC 7515 Section 4.1.3, only public keys are allowed to be embedded.
|
||||||
|
jwk := obj.Signatures[i].Header.JSONWebKey
|
||||||
|
if jwk != nil && (!jwk.Valid() || !jwk.IsPublic()) {
|
||||||
|
return nil, errors.New("go-jose/go-jose: invalid embedded jwk, must be public key")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Copy value of sig
|
||||||
|
original := sig
|
||||||
|
|
||||||
|
obj.Signatures[i].header = sig.Header
|
||||||
|
obj.Signatures[i].original = &original
|
||||||
|
}
|
||||||
|
|
||||||
|
return obj, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseSignedCompact parses a message in compact format.
|
||||||
|
func parseSignedCompact(input string, payload []byte) (*JSONWebSignature, error) {
|
||||||
|
parts := strings.Split(input, ".")
|
||||||
|
if len(parts) != 3 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: compact JWS format must have three parts")
|
||||||
|
}
|
||||||
|
|
||||||
|
if parts[1] != "" && payload != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: payload is not detached")
|
||||||
|
}
|
||||||
|
|
||||||
|
rawProtected, err := base64URLDecode(parts[0])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if payload == nil {
|
||||||
|
payload, err = base64URLDecode(parts[1])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
signature, err := base64URLDecode(parts[2])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
raw := &rawJSONWebSignature{
|
||||||
|
Payload: newBuffer(payload),
|
||||||
|
Protected: newBuffer(rawProtected),
|
||||||
|
Signature: newBuffer(signature),
|
||||||
|
}
|
||||||
|
return raw.sanitized()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (obj JSONWebSignature) compactSerialize(detached bool) (string, error) {
|
||||||
|
if len(obj.Signatures) != 1 || obj.Signatures[0].header != nil || obj.Signatures[0].protected == nil {
|
||||||
|
return "", ErrNotSupported
|
||||||
|
}
|
||||||
|
|
||||||
|
serializedProtected := mustSerializeJSON(obj.Signatures[0].protected)
|
||||||
|
|
||||||
|
var payload []byte
|
||||||
|
if !detached {
|
||||||
|
payload = obj.payload
|
||||||
|
}
|
||||||
|
|
||||||
|
return base64JoinWithDots(
|
||||||
|
serializedProtected,
|
||||||
|
payload,
|
||||||
|
obj.Signatures[0].Signature,
|
||||||
|
), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompactSerialize serializes an object using the compact serialization format.
|
||||||
|
func (obj JSONWebSignature) CompactSerialize() (string, error) {
|
||||||
|
return obj.compactSerialize(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DetachedCompactSerialize serializes an object using the compact serialization format with detached payload.
|
||||||
|
func (obj JSONWebSignature) DetachedCompactSerialize() (string, error) {
|
||||||
|
return obj.compactSerialize(true)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FullSerialize serializes an object using the full JSON serialization format.
|
||||||
|
func (obj JSONWebSignature) FullSerialize() string {
|
||||||
|
raw := rawJSONWebSignature{
|
||||||
|
Payload: newBuffer(obj.payload),
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(obj.Signatures) == 1 {
|
||||||
|
if obj.Signatures[0].protected != nil {
|
||||||
|
serializedProtected := mustSerializeJSON(obj.Signatures[0].protected)
|
||||||
|
raw.Protected = newBuffer(serializedProtected)
|
||||||
|
}
|
||||||
|
raw.Header = obj.Signatures[0].header
|
||||||
|
raw.Signature = newBuffer(obj.Signatures[0].Signature)
|
||||||
|
} else {
|
||||||
|
raw.Signatures = make([]rawSignatureInfo, len(obj.Signatures))
|
||||||
|
for i, signature := range obj.Signatures {
|
||||||
|
raw.Signatures[i] = rawSignatureInfo{
|
||||||
|
Header: signature.header,
|
||||||
|
Signature: newBuffer(signature.Signature),
|
||||||
|
}
|
||||||
|
|
||||||
|
if signature.protected != nil {
|
||||||
|
raw.Signatures[i].Protected = newBuffer(mustSerializeJSON(signature.protected))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return string(mustSerializeJSON(raw))
|
||||||
|
}
|
|
@ -0,0 +1,334 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2016 Zbigniew Mandziejewicz
|
||||||
|
* Copyright 2016 Square, Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jwt
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"reflect"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Builder is a utility for making JSON Web Tokens. Calls can be chained, and
|
||||||
|
// errors are accumulated until the final call to CompactSerialize/FullSerialize.
|
||||||
|
type Builder interface {
|
||||||
|
// Claims encodes claims into JWE/JWS form. Multiple calls will merge claims
|
||||||
|
// into single JSON object. If you are passing private claims, make sure to set
|
||||||
|
// struct field tags to specify the name for the JSON key to be used when
|
||||||
|
// serializing.
|
||||||
|
Claims(i interface{}) Builder
|
||||||
|
// Token builds a JSONWebToken from provided data.
|
||||||
|
Token() (*JSONWebToken, error)
|
||||||
|
// FullSerialize serializes a token using the JWS/JWE JSON Serialization format.
|
||||||
|
FullSerialize() (string, error)
|
||||||
|
// CompactSerialize serializes a token using the compact serialization format.
|
||||||
|
CompactSerialize() (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NestedBuilder is a utility for making Signed-Then-Encrypted JSON Web Tokens.
|
||||||
|
// Calls can be chained, and errors are accumulated until final call to
|
||||||
|
// CompactSerialize/FullSerialize.
|
||||||
|
type NestedBuilder interface {
|
||||||
|
// Claims encodes claims into JWE/JWS form. Multiple calls will merge claims
|
||||||
|
// into single JSON object. If you are passing private claims, make sure to set
|
||||||
|
// struct field tags to specify the name for the JSON key to be used when
|
||||||
|
// serializing.
|
||||||
|
Claims(i interface{}) NestedBuilder
|
||||||
|
// Token builds a NestedJSONWebToken from provided data.
|
||||||
|
Token() (*NestedJSONWebToken, error)
|
||||||
|
// FullSerialize serializes a token using the JSON Serialization format.
|
||||||
|
FullSerialize() (string, error)
|
||||||
|
// CompactSerialize serializes a token using the compact serialization format.
|
||||||
|
CompactSerialize() (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type builder struct {
|
||||||
|
payload map[string]interface{}
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
type signedBuilder struct {
|
||||||
|
builder
|
||||||
|
sig jose.Signer
|
||||||
|
}
|
||||||
|
|
||||||
|
type encryptedBuilder struct {
|
||||||
|
builder
|
||||||
|
enc jose.Encrypter
|
||||||
|
}
|
||||||
|
|
||||||
|
type nestedBuilder struct {
|
||||||
|
builder
|
||||||
|
sig jose.Signer
|
||||||
|
enc jose.Encrypter
|
||||||
|
}
|
||||||
|
|
||||||
|
// Signed creates builder for signed tokens.
|
||||||
|
func Signed(sig jose.Signer) Builder {
|
||||||
|
return &signedBuilder{
|
||||||
|
sig: sig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypted creates builder for encrypted tokens.
|
||||||
|
func Encrypted(enc jose.Encrypter) Builder {
|
||||||
|
return &encryptedBuilder{
|
||||||
|
enc: enc,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SignedAndEncrypted creates builder for signed-then-encrypted tokens.
|
||||||
|
// ErrInvalidContentType will be returned if encrypter doesn't have JWT content type.
|
||||||
|
func SignedAndEncrypted(sig jose.Signer, enc jose.Encrypter) NestedBuilder {
|
||||||
|
if contentType, _ := enc.Options().ExtraHeaders[jose.HeaderContentType].(jose.ContentType); contentType != "JWT" {
|
||||||
|
return &nestedBuilder{
|
||||||
|
builder: builder{
|
||||||
|
err: ErrInvalidContentType,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return &nestedBuilder{
|
||||||
|
sig: sig,
|
||||||
|
enc: enc,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b builder) claims(i interface{}) builder {
|
||||||
|
if b.err != nil {
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
m, ok := i.(map[string]interface{})
|
||||||
|
switch {
|
||||||
|
case ok:
|
||||||
|
return b.merge(m)
|
||||||
|
case reflect.Indirect(reflect.ValueOf(i)).Kind() == reflect.Struct:
|
||||||
|
m, err := normalize(i)
|
||||||
|
if err != nil {
|
||||||
|
return builder{
|
||||||
|
err: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return b.merge(m)
|
||||||
|
default:
|
||||||
|
return builder{
|
||||||
|
err: ErrInvalidClaims,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func normalize(i interface{}) (map[string]interface{}, error) {
|
||||||
|
m := make(map[string]interface{})
|
||||||
|
|
||||||
|
raw, err := json.Marshal(i)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
d := json.NewDecoder(bytes.NewReader(raw))
|
||||||
|
d.SetNumberType(json.UnmarshalJSONNumber)
|
||||||
|
|
||||||
|
if err := d.Decode(&m); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *builder) merge(m map[string]interface{}) builder {
|
||||||
|
p := make(map[string]interface{})
|
||||||
|
for k, v := range b.payload {
|
||||||
|
p[k] = v
|
||||||
|
}
|
||||||
|
for k, v := range m {
|
||||||
|
p[k] = v
|
||||||
|
}
|
||||||
|
|
||||||
|
return builder{
|
||||||
|
payload: p,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *builder) token(p func(interface{}) ([]byte, error), h []jose.Header) (*JSONWebToken, error) {
|
||||||
|
return &JSONWebToken{
|
||||||
|
payload: p,
|
||||||
|
Headers: h,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *signedBuilder) Claims(i interface{}) Builder {
|
||||||
|
return &signedBuilder{
|
||||||
|
builder: b.builder.claims(i),
|
||||||
|
sig: b.sig,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *signedBuilder) Token() (*JSONWebToken, error) {
|
||||||
|
sig, err := b.sign()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
h := make([]jose.Header, len(sig.Signatures))
|
||||||
|
for i, v := range sig.Signatures {
|
||||||
|
h[i] = v.Header
|
||||||
|
}
|
||||||
|
|
||||||
|
return b.builder.token(sig.Verify, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *signedBuilder) CompactSerialize() (string, error) {
|
||||||
|
sig, err := b.sign()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return sig.CompactSerialize()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *signedBuilder) FullSerialize() (string, error) {
|
||||||
|
sig, err := b.sign()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return sig.FullSerialize(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *signedBuilder) sign() (*jose.JSONWebSignature, error) {
|
||||||
|
if b.err != nil {
|
||||||
|
return nil, b.err
|
||||||
|
}
|
||||||
|
|
||||||
|
p, err := json.Marshal(b.payload)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return b.sig.Sign(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *encryptedBuilder) Claims(i interface{}) Builder {
|
||||||
|
return &encryptedBuilder{
|
||||||
|
builder: b.builder.claims(i),
|
||||||
|
enc: b.enc,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *encryptedBuilder) CompactSerialize() (string, error) {
|
||||||
|
enc, err := b.encrypt()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return enc.CompactSerialize()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *encryptedBuilder) FullSerialize() (string, error) {
|
||||||
|
enc, err := b.encrypt()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return enc.FullSerialize(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *encryptedBuilder) Token() (*JSONWebToken, error) {
|
||||||
|
enc, err := b.encrypt()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return b.builder.token(enc.Decrypt, []jose.Header{enc.Header})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *encryptedBuilder) encrypt() (*jose.JSONWebEncryption, error) {
|
||||||
|
if b.err != nil {
|
||||||
|
return nil, b.err
|
||||||
|
}
|
||||||
|
|
||||||
|
p, err := json.Marshal(b.payload)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return b.enc.Encrypt(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *nestedBuilder) Claims(i interface{}) NestedBuilder {
|
||||||
|
return &nestedBuilder{
|
||||||
|
builder: b.builder.claims(i),
|
||||||
|
sig: b.sig,
|
||||||
|
enc: b.enc,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *nestedBuilder) Token() (*NestedJSONWebToken, error) {
|
||||||
|
enc, err := b.signAndEncrypt()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &NestedJSONWebToken{
|
||||||
|
enc: enc,
|
||||||
|
Headers: []jose.Header{enc.Header},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *nestedBuilder) CompactSerialize() (string, error) {
|
||||||
|
enc, err := b.signAndEncrypt()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return enc.CompactSerialize()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *nestedBuilder) FullSerialize() (string, error) {
|
||||||
|
enc, err := b.signAndEncrypt()
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return enc.FullSerialize(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *nestedBuilder) signAndEncrypt() (*jose.JSONWebEncryption, error) {
|
||||||
|
if b.err != nil {
|
||||||
|
return nil, b.err
|
||||||
|
}
|
||||||
|
|
||||||
|
p, err := json.Marshal(b.payload)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
sig, err := b.sig.Sign(p)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
p2, err := sig.CompactSerialize()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return b.enc.Encrypt([]byte(p2))
|
||||||
|
}
|
|
@ -0,0 +1,130 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2016 Zbigniew Mandziejewicz
|
||||||
|
* Copyright 2016 Square, Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jwt
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Claims represents public claim values (as specified in RFC 7519).
|
||||||
|
type Claims struct {
|
||||||
|
Issuer string `json:"iss,omitempty"`
|
||||||
|
Subject string `json:"sub,omitempty"`
|
||||||
|
Audience Audience `json:"aud,omitempty"`
|
||||||
|
Expiry *NumericDate `json:"exp,omitempty"`
|
||||||
|
NotBefore *NumericDate `json:"nbf,omitempty"`
|
||||||
|
IssuedAt *NumericDate `json:"iat,omitempty"`
|
||||||
|
ID string `json:"jti,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NumericDate represents date and time as the number of seconds since the
|
||||||
|
// epoch, ignoring leap seconds. Non-integer values can be represented
|
||||||
|
// in the serialized format, but we round to the nearest second.
|
||||||
|
// See RFC7519 Section 2: https://tools.ietf.org/html/rfc7519#section-2
|
||||||
|
type NumericDate int64
|
||||||
|
|
||||||
|
// NewNumericDate constructs NumericDate from time.Time value.
|
||||||
|
func NewNumericDate(t time.Time) *NumericDate {
|
||||||
|
if t.IsZero() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// While RFC 7519 technically states that NumericDate values may be
|
||||||
|
// non-integer values, we don't bother serializing timestamps in
|
||||||
|
// claims with sub-second accurancy and just round to the nearest
|
||||||
|
// second instead. Not convined sub-second accuracy is useful here.
|
||||||
|
out := NumericDate(t.Unix())
|
||||||
|
return &out
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON serializes the given NumericDate into its JSON representation.
|
||||||
|
func (n NumericDate) MarshalJSON() ([]byte, error) {
|
||||||
|
return []byte(strconv.FormatInt(int64(n), 10)), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON reads a date from its JSON representation.
|
||||||
|
func (n *NumericDate) UnmarshalJSON(b []byte) error {
|
||||||
|
s := string(b)
|
||||||
|
|
||||||
|
f, err := strconv.ParseFloat(s, 64)
|
||||||
|
if err != nil {
|
||||||
|
return ErrUnmarshalNumericDate
|
||||||
|
}
|
||||||
|
|
||||||
|
*n = NumericDate(f)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Time returns time.Time representation of NumericDate.
|
||||||
|
func (n *NumericDate) Time() time.Time {
|
||||||
|
if n == nil {
|
||||||
|
return time.Time{}
|
||||||
|
}
|
||||||
|
return time.Unix(int64(*n), 0)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Audience represents the recipients that the token is intended for.
|
||||||
|
type Audience []string
|
||||||
|
|
||||||
|
// UnmarshalJSON reads an audience from its JSON representation.
|
||||||
|
func (s *Audience) UnmarshalJSON(b []byte) error {
|
||||||
|
var v interface{}
|
||||||
|
if err := json.Unmarshal(b, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
switch v := v.(type) {
|
||||||
|
case string:
|
||||||
|
*s = []string{v}
|
||||||
|
case []interface{}:
|
||||||
|
a := make([]string, len(v))
|
||||||
|
for i, e := range v {
|
||||||
|
s, ok := e.(string)
|
||||||
|
if !ok {
|
||||||
|
return ErrUnmarshalAudience
|
||||||
|
}
|
||||||
|
a[i] = s
|
||||||
|
}
|
||||||
|
*s = a
|
||||||
|
default:
|
||||||
|
return ErrUnmarshalAudience
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON converts audience to json representation.
|
||||||
|
func (s Audience) MarshalJSON() ([]byte, error) {
|
||||||
|
if len(s) == 1 {
|
||||||
|
return json.Marshal(s[0])
|
||||||
|
}
|
||||||
|
return json.Marshal([]string(s))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Contains checks whether a given string is included in the Audience
|
||||||
|
func (s Audience) Contains(v string) bool {
|
||||||
|
for _, a := range s {
|
||||||
|
if a == v {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
|
@ -0,0 +1,20 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2017 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
Package jwt provides an implementation of the JSON Web Token standard.
|
||||||
|
*/
|
||||||
|
package jwt
|
|
@ -0,0 +1,53 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2016 Zbigniew Mandziejewicz
|
||||||
|
* Copyright 2016 Square, Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jwt
|
||||||
|
|
||||||
|
import "errors"
|
||||||
|
|
||||||
|
// ErrUnmarshalAudience indicates that aud claim could not be unmarshalled.
|
||||||
|
var ErrUnmarshalAudience = errors.New("go-jose/go-jose/jwt: expected string or array value to unmarshal to Audience")
|
||||||
|
|
||||||
|
// ErrUnmarshalNumericDate indicates that JWT NumericDate could not be unmarshalled.
|
||||||
|
var ErrUnmarshalNumericDate = errors.New("go-jose/go-jose/jwt: expected number value to unmarshal NumericDate")
|
||||||
|
|
||||||
|
// ErrInvalidClaims indicates that given claims have invalid type.
|
||||||
|
var ErrInvalidClaims = errors.New("go-jose/go-jose/jwt: expected claims to be value convertible into JSON object")
|
||||||
|
|
||||||
|
// ErrInvalidIssuer indicates invalid iss claim.
|
||||||
|
var ErrInvalidIssuer = errors.New("go-jose/go-jose/jwt: validation failed, invalid issuer claim (iss)")
|
||||||
|
|
||||||
|
// ErrInvalidSubject indicates invalid sub claim.
|
||||||
|
var ErrInvalidSubject = errors.New("go-jose/go-jose/jwt: validation failed, invalid subject claim (sub)")
|
||||||
|
|
||||||
|
// ErrInvalidAudience indicated invalid aud claim.
|
||||||
|
var ErrInvalidAudience = errors.New("go-jose/go-jose/jwt: validation failed, invalid audience claim (aud)")
|
||||||
|
|
||||||
|
// ErrInvalidID indicates invalid jti claim.
|
||||||
|
var ErrInvalidID = errors.New("go-jose/go-jose/jwt: validation failed, invalid ID claim (jti)")
|
||||||
|
|
||||||
|
// ErrNotValidYet indicates that token is used before time indicated in nbf claim.
|
||||||
|
var ErrNotValidYet = errors.New("go-jose/go-jose/jwt: validation failed, token not valid yet (nbf)")
|
||||||
|
|
||||||
|
// ErrExpired indicates that token is used after expiry time indicated in exp claim.
|
||||||
|
var ErrExpired = errors.New("go-jose/go-jose/jwt: validation failed, token is expired (exp)")
|
||||||
|
|
||||||
|
// ErrIssuedInTheFuture indicates that the iat field is in the future.
|
||||||
|
var ErrIssuedInTheFuture = errors.New("go-jose/go-jose/jwt: validation field, token issued in the future (iat)")
|
||||||
|
|
||||||
|
// ErrInvalidContentType indicates that token requires JWT cty header.
|
||||||
|
var ErrInvalidContentType = errors.New("go-jose/go-jose/jwt: expected content type to be JWT (cty header)")
|
|
@ -0,0 +1,133 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2016 Zbigniew Mandziejewicz
|
||||||
|
* Copyright 2016 Square, Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jwt
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
jose "github.com/go-jose/go-jose/v3"
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// JSONWebToken represents a JSON Web Token (as specified in RFC7519).
|
||||||
|
type JSONWebToken struct {
|
||||||
|
payload func(k interface{}) ([]byte, error)
|
||||||
|
unverifiedPayload func() []byte
|
||||||
|
Headers []jose.Header
|
||||||
|
}
|
||||||
|
|
||||||
|
type NestedJSONWebToken struct {
|
||||||
|
enc *jose.JSONWebEncryption
|
||||||
|
Headers []jose.Header
|
||||||
|
}
|
||||||
|
|
||||||
|
// Claims deserializes a JSONWebToken into dest using the provided key.
|
||||||
|
func (t *JSONWebToken) Claims(key interface{}, dest ...interface{}) error {
|
||||||
|
b, err := t.payload(key)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, d := range dest {
|
||||||
|
if err := json.Unmarshal(b, d); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnsafeClaimsWithoutVerification deserializes the claims of a
|
||||||
|
// JSONWebToken into the dests. For signed JWTs, the claims are not
|
||||||
|
// verified. This function won't work for encrypted JWTs.
|
||||||
|
func (t *JSONWebToken) UnsafeClaimsWithoutVerification(dest ...interface{}) error {
|
||||||
|
if t.unverifiedPayload == nil {
|
||||||
|
return fmt.Errorf("go-jose/go-jose: Cannot get unverified claims")
|
||||||
|
}
|
||||||
|
claims := t.unverifiedPayload()
|
||||||
|
for _, d := range dest {
|
||||||
|
if err := json.Unmarshal(claims, d); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *NestedJSONWebToken) Decrypt(decryptionKey interface{}) (*JSONWebToken, error) {
|
||||||
|
b, err := t.enc.Decrypt(decryptionKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
sig, err := ParseSigned(string(b))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return sig, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseSigned parses token from JWS form.
|
||||||
|
func ParseSigned(s string) (*JSONWebToken, error) {
|
||||||
|
sig, err := jose.ParseSigned(s)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
headers := make([]jose.Header, len(sig.Signatures))
|
||||||
|
for i, signature := range sig.Signatures {
|
||||||
|
headers[i] = signature.Header
|
||||||
|
}
|
||||||
|
|
||||||
|
return &JSONWebToken{
|
||||||
|
payload: sig.Verify,
|
||||||
|
unverifiedPayload: sig.UnsafePayloadWithoutVerification,
|
||||||
|
Headers: headers,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseEncrypted parses token from JWE form.
|
||||||
|
func ParseEncrypted(s string) (*JSONWebToken, error) {
|
||||||
|
enc, err := jose.ParseEncrypted(s)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &JSONWebToken{
|
||||||
|
payload: enc.Decrypt,
|
||||||
|
Headers: []jose.Header{enc.Header},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseSignedAndEncrypted parses signed-then-encrypted token from JWE form.
|
||||||
|
func ParseSignedAndEncrypted(s string) (*NestedJSONWebToken, error) {
|
||||||
|
enc, err := jose.ParseEncrypted(s)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType, _ := enc.Header.ExtraHeaders[jose.HeaderContentType].(string)
|
||||||
|
if strings.ToUpper(contentType) != "JWT" {
|
||||||
|
return nil, ErrInvalidContentType
|
||||||
|
}
|
||||||
|
|
||||||
|
return &NestedJSONWebToken{
|
||||||
|
enc: enc,
|
||||||
|
Headers: []jose.Header{enc.Header},
|
||||||
|
}, nil
|
||||||
|
}
|
|
@ -0,0 +1,120 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2016 Zbigniew Mandziejewicz
|
||||||
|
* Copyright 2016 Square, Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jwt
|
||||||
|
|
||||||
|
import "time"
|
||||||
|
|
||||||
|
const (
|
||||||
|
// DefaultLeeway defines the default leeway for matching NotBefore/Expiry claims.
|
||||||
|
DefaultLeeway = 1.0 * time.Minute
|
||||||
|
)
|
||||||
|
|
||||||
|
// Expected defines values used for protected claims validation.
|
||||||
|
// If field has zero value then validation is skipped, with the exception of
|
||||||
|
// Time, where the zero value means "now." To skip validating them, set the
|
||||||
|
// corresponding field in the Claims struct to nil.
|
||||||
|
type Expected struct {
|
||||||
|
// Issuer matches the "iss" claim exactly.
|
||||||
|
Issuer string
|
||||||
|
// Subject matches the "sub" claim exactly.
|
||||||
|
Subject string
|
||||||
|
// Audience matches the values in "aud" claim, regardless of their order.
|
||||||
|
Audience Audience
|
||||||
|
// ID matches the "jti" claim exactly.
|
||||||
|
ID string
|
||||||
|
// Time matches the "exp", "nbf" and "iat" claims with leeway.
|
||||||
|
Time time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTime copies expectations with new time.
|
||||||
|
func (e Expected) WithTime(t time.Time) Expected {
|
||||||
|
e.Time = t
|
||||||
|
return e
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate checks claims in a token against expected values.
|
||||||
|
// A default leeway value of one minute is used to compare time values.
|
||||||
|
//
|
||||||
|
// The default leeway will cause the token to be deemed valid until one
|
||||||
|
// minute after the expiration time. If you're a server application that
|
||||||
|
// wants to give an extra minute to client tokens, use this
|
||||||
|
// function. If you're a client application wondering if the server
|
||||||
|
// will accept your token, use ValidateWithLeeway with a leeway <=0,
|
||||||
|
// otherwise this function might make you think a token is valid when
|
||||||
|
// it is not.
|
||||||
|
func (c Claims) Validate(e Expected) error {
|
||||||
|
return c.ValidateWithLeeway(e, DefaultLeeway)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ValidateWithLeeway checks claims in a token against expected values. A
|
||||||
|
// custom leeway may be specified for comparing time values. You may pass a
|
||||||
|
// zero value to check time values with no leeway, but you should note that
|
||||||
|
// numeric date values are rounded to the nearest second and sub-second
|
||||||
|
// precision is not supported.
|
||||||
|
//
|
||||||
|
// The leeway gives some extra time to the token from the server's
|
||||||
|
// point of view. That is, if the token is expired, ValidateWithLeeway
|
||||||
|
// will still accept the token for 'leeway' amount of time. This fails
|
||||||
|
// if you're using this function to check if a server will accept your
|
||||||
|
// token, because it will think the token is valid even after it
|
||||||
|
// expires. So if you're a client validating if the token is valid to
|
||||||
|
// be submitted to a server, use leeway <=0, if you're a server
|
||||||
|
// validation a token, use leeway >=0.
|
||||||
|
func (c Claims) ValidateWithLeeway(e Expected, leeway time.Duration) error {
|
||||||
|
if e.Issuer != "" && e.Issuer != c.Issuer {
|
||||||
|
return ErrInvalidIssuer
|
||||||
|
}
|
||||||
|
|
||||||
|
if e.Subject != "" && e.Subject != c.Subject {
|
||||||
|
return ErrInvalidSubject
|
||||||
|
}
|
||||||
|
|
||||||
|
if e.ID != "" && e.ID != c.ID {
|
||||||
|
return ErrInvalidID
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(e.Audience) != 0 {
|
||||||
|
for _, v := range e.Audience {
|
||||||
|
if !c.Audience.Contains(v) {
|
||||||
|
return ErrInvalidAudience
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// validate using the e.Time, or time.Now if not provided
|
||||||
|
validationTime := e.Time
|
||||||
|
if validationTime.IsZero() {
|
||||||
|
validationTime = time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.NotBefore != nil && validationTime.Add(leeway).Before(c.NotBefore.Time()) {
|
||||||
|
return ErrNotValidYet
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.Expiry != nil && validationTime.Add(-leeway).After(c.Expiry.Time()) {
|
||||||
|
return ErrExpired
|
||||||
|
}
|
||||||
|
|
||||||
|
// IssuedAt is optional but cannot be in the future. This is not required by the RFC, but
|
||||||
|
// something is misconfigured if this happens and we should not trust it.
|
||||||
|
if c.IssuedAt != nil && validationTime.Add(leeway).Before(c.IssuedAt.Time()) {
|
||||||
|
return ErrIssuedInTheFuture
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
|
@ -0,0 +1,144 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2018 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
// OpaqueSigner is an interface that supports signing payloads with opaque
|
||||||
|
// private key(s). Private key operations performed by implementers may, for
|
||||||
|
// example, occur in a hardware module. An OpaqueSigner may rotate signing keys
|
||||||
|
// transparently to the user of this interface.
|
||||||
|
type OpaqueSigner interface {
|
||||||
|
// Public returns the public key of the current signing key.
|
||||||
|
Public() *JSONWebKey
|
||||||
|
// Algs returns a list of supported signing algorithms.
|
||||||
|
Algs() []SignatureAlgorithm
|
||||||
|
// SignPayload signs a payload with the current signing key using the given
|
||||||
|
// algorithm.
|
||||||
|
SignPayload(payload []byte, alg SignatureAlgorithm) ([]byte, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type opaqueSigner struct {
|
||||||
|
signer OpaqueSigner
|
||||||
|
}
|
||||||
|
|
||||||
|
func newOpaqueSigner(alg SignatureAlgorithm, signer OpaqueSigner) (recipientSigInfo, error) {
|
||||||
|
var algSupported bool
|
||||||
|
for _, salg := range signer.Algs() {
|
||||||
|
if alg == salg {
|
||||||
|
algSupported = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !algSupported {
|
||||||
|
return recipientSigInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientSigInfo{
|
||||||
|
sigAlg: alg,
|
||||||
|
publicKey: signer.Public,
|
||||||
|
signer: &opaqueSigner{
|
||||||
|
signer: signer,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *opaqueSigner) signPayload(payload []byte, alg SignatureAlgorithm) (Signature, error) {
|
||||||
|
out, err := o.signer.SignPayload(payload, alg)
|
||||||
|
if err != nil {
|
||||||
|
return Signature{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return Signature{
|
||||||
|
Signature: out,
|
||||||
|
protected: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpaqueVerifier is an interface that supports verifying payloads with opaque
|
||||||
|
// public key(s). An OpaqueSigner may rotate signing keys transparently to the
|
||||||
|
// user of this interface.
|
||||||
|
type OpaqueVerifier interface {
|
||||||
|
VerifyPayload(payload []byte, signature []byte, alg SignatureAlgorithm) error
|
||||||
|
}
|
||||||
|
|
||||||
|
type opaqueVerifier struct {
|
||||||
|
verifier OpaqueVerifier
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *opaqueVerifier) verifyPayload(payload []byte, signature []byte, alg SignatureAlgorithm) error {
|
||||||
|
return o.verifier.VerifyPayload(payload, signature, alg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpaqueKeyEncrypter is an interface that supports encrypting keys with an opaque key.
|
||||||
|
type OpaqueKeyEncrypter interface {
|
||||||
|
// KeyID returns the kid
|
||||||
|
KeyID() string
|
||||||
|
// Algs returns a list of supported key encryption algorithms.
|
||||||
|
Algs() []KeyAlgorithm
|
||||||
|
// encryptKey encrypts the CEK using the given algorithm.
|
||||||
|
encryptKey(cek []byte, alg KeyAlgorithm) (recipientInfo, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type opaqueKeyEncrypter struct {
|
||||||
|
encrypter OpaqueKeyEncrypter
|
||||||
|
}
|
||||||
|
|
||||||
|
func newOpaqueKeyEncrypter(alg KeyAlgorithm, encrypter OpaqueKeyEncrypter) (recipientKeyInfo, error) {
|
||||||
|
var algSupported bool
|
||||||
|
for _, salg := range encrypter.Algs() {
|
||||||
|
if alg == salg {
|
||||||
|
algSupported = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !algSupported {
|
||||||
|
return recipientKeyInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientKeyInfo{
|
||||||
|
keyID: encrypter.KeyID(),
|
||||||
|
keyAlg: alg,
|
||||||
|
keyEncrypter: &opaqueKeyEncrypter{
|
||||||
|
encrypter: encrypter,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (oke *opaqueKeyEncrypter) encryptKey(cek []byte, alg KeyAlgorithm) (recipientInfo, error) {
|
||||||
|
return oke.encrypter.encryptKey(cek, alg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpaqueKeyDecrypter is an interface that supports decrypting keys with an opaque key.
|
||||||
|
type OpaqueKeyDecrypter interface {
|
||||||
|
DecryptKey(encryptedKey []byte, header Header) ([]byte, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type opaqueKeyDecrypter struct {
|
||||||
|
decrypter OpaqueKeyDecrypter
|
||||||
|
}
|
||||||
|
|
||||||
|
func (okd *opaqueKeyDecrypter) decryptKey(headers rawHeader, recipient *recipientInfo, generator keyGenerator) ([]byte, error) {
|
||||||
|
mergedHeaders := rawHeader{}
|
||||||
|
mergedHeaders.merge(&headers)
|
||||||
|
mergedHeaders.merge(recipient.header)
|
||||||
|
|
||||||
|
header, err := mergedHeaders.sanitized()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return okd.decrypter.DecryptKey(recipient.encryptedKey, header)
|
||||||
|
}
|
|
@ -0,0 +1,525 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/x509"
|
||||||
|
"encoding/base64"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// KeyAlgorithm represents a key management algorithm.
|
||||||
|
type KeyAlgorithm string
|
||||||
|
|
||||||
|
// SignatureAlgorithm represents a signature (or MAC) algorithm.
|
||||||
|
type SignatureAlgorithm string
|
||||||
|
|
||||||
|
// ContentEncryption represents a content encryption algorithm.
|
||||||
|
type ContentEncryption string
|
||||||
|
|
||||||
|
// CompressionAlgorithm represents an algorithm used for plaintext compression.
|
||||||
|
type CompressionAlgorithm string
|
||||||
|
|
||||||
|
// ContentType represents type of the contained data.
|
||||||
|
type ContentType string
|
||||||
|
|
||||||
|
var (
|
||||||
|
// ErrCryptoFailure represents an error in cryptographic primitive. This
|
||||||
|
// occurs when, for example, a message had an invalid authentication tag or
|
||||||
|
// could not be decrypted.
|
||||||
|
ErrCryptoFailure = errors.New("go-jose/go-jose: error in cryptographic primitive")
|
||||||
|
|
||||||
|
// ErrUnsupportedAlgorithm indicates that a selected algorithm is not
|
||||||
|
// supported. This occurs when trying to instantiate an encrypter for an
|
||||||
|
// algorithm that is not yet implemented.
|
||||||
|
ErrUnsupportedAlgorithm = errors.New("go-jose/go-jose: unknown/unsupported algorithm")
|
||||||
|
|
||||||
|
// ErrUnsupportedKeyType indicates that the given key type/format is not
|
||||||
|
// supported. This occurs when trying to instantiate an encrypter and passing
|
||||||
|
// it a key of an unrecognized type or with unsupported parameters, such as
|
||||||
|
// an RSA private key with more than two primes.
|
||||||
|
ErrUnsupportedKeyType = errors.New("go-jose/go-jose: unsupported key type/format")
|
||||||
|
|
||||||
|
// ErrInvalidKeySize indicates that the given key is not the correct size
|
||||||
|
// for the selected algorithm. This can occur, for example, when trying to
|
||||||
|
// encrypt with AES-256 but passing only a 128-bit key as input.
|
||||||
|
ErrInvalidKeySize = errors.New("go-jose/go-jose: invalid key size for algorithm")
|
||||||
|
|
||||||
|
// ErrNotSupported serialization of object is not supported. This occurs when
|
||||||
|
// trying to compact-serialize an object which can't be represented in
|
||||||
|
// compact form.
|
||||||
|
ErrNotSupported = errors.New("go-jose/go-jose: compact serialization not supported for object")
|
||||||
|
|
||||||
|
// ErrUnprotectedNonce indicates that while parsing a JWS or JWE object, a
|
||||||
|
// nonce header parameter was included in an unprotected header object.
|
||||||
|
ErrUnprotectedNonce = errors.New("go-jose/go-jose: Nonce parameter included in unprotected header")
|
||||||
|
)
|
||||||
|
|
||||||
|
// Key management algorithms
|
||||||
|
const (
|
||||||
|
ED25519 = KeyAlgorithm("ED25519")
|
||||||
|
RSA1_5 = KeyAlgorithm("RSA1_5") // RSA-PKCS1v1.5
|
||||||
|
RSA_OAEP = KeyAlgorithm("RSA-OAEP") // RSA-OAEP-SHA1
|
||||||
|
RSA_OAEP_256 = KeyAlgorithm("RSA-OAEP-256") // RSA-OAEP-SHA256
|
||||||
|
A128KW = KeyAlgorithm("A128KW") // AES key wrap (128)
|
||||||
|
A192KW = KeyAlgorithm("A192KW") // AES key wrap (192)
|
||||||
|
A256KW = KeyAlgorithm("A256KW") // AES key wrap (256)
|
||||||
|
DIRECT = KeyAlgorithm("dir") // Direct encryption
|
||||||
|
ECDH_ES = KeyAlgorithm("ECDH-ES") // ECDH-ES
|
||||||
|
ECDH_ES_A128KW = KeyAlgorithm("ECDH-ES+A128KW") // ECDH-ES + AES key wrap (128)
|
||||||
|
ECDH_ES_A192KW = KeyAlgorithm("ECDH-ES+A192KW") // ECDH-ES + AES key wrap (192)
|
||||||
|
ECDH_ES_A256KW = KeyAlgorithm("ECDH-ES+A256KW") // ECDH-ES + AES key wrap (256)
|
||||||
|
A128GCMKW = KeyAlgorithm("A128GCMKW") // AES-GCM key wrap (128)
|
||||||
|
A192GCMKW = KeyAlgorithm("A192GCMKW") // AES-GCM key wrap (192)
|
||||||
|
A256GCMKW = KeyAlgorithm("A256GCMKW") // AES-GCM key wrap (256)
|
||||||
|
PBES2_HS256_A128KW = KeyAlgorithm("PBES2-HS256+A128KW") // PBES2 + HMAC-SHA256 + AES key wrap (128)
|
||||||
|
PBES2_HS384_A192KW = KeyAlgorithm("PBES2-HS384+A192KW") // PBES2 + HMAC-SHA384 + AES key wrap (192)
|
||||||
|
PBES2_HS512_A256KW = KeyAlgorithm("PBES2-HS512+A256KW") // PBES2 + HMAC-SHA512 + AES key wrap (256)
|
||||||
|
)
|
||||||
|
|
||||||
|
// Signature algorithms
|
||||||
|
const (
|
||||||
|
EdDSA = SignatureAlgorithm("EdDSA")
|
||||||
|
HS256 = SignatureAlgorithm("HS256") // HMAC using SHA-256
|
||||||
|
HS384 = SignatureAlgorithm("HS384") // HMAC using SHA-384
|
||||||
|
HS512 = SignatureAlgorithm("HS512") // HMAC using SHA-512
|
||||||
|
RS256 = SignatureAlgorithm("RS256") // RSASSA-PKCS-v1.5 using SHA-256
|
||||||
|
RS384 = SignatureAlgorithm("RS384") // RSASSA-PKCS-v1.5 using SHA-384
|
||||||
|
RS512 = SignatureAlgorithm("RS512") // RSASSA-PKCS-v1.5 using SHA-512
|
||||||
|
ES256 = SignatureAlgorithm("ES256") // ECDSA using P-256 and SHA-256
|
||||||
|
ES384 = SignatureAlgorithm("ES384") // ECDSA using P-384 and SHA-384
|
||||||
|
ES512 = SignatureAlgorithm("ES512") // ECDSA using P-521 and SHA-512
|
||||||
|
PS256 = SignatureAlgorithm("PS256") // RSASSA-PSS using SHA256 and MGF1-SHA256
|
||||||
|
PS384 = SignatureAlgorithm("PS384") // RSASSA-PSS using SHA384 and MGF1-SHA384
|
||||||
|
PS512 = SignatureAlgorithm("PS512") // RSASSA-PSS using SHA512 and MGF1-SHA512
|
||||||
|
)
|
||||||
|
|
||||||
|
// Content encryption algorithms
|
||||||
|
const (
|
||||||
|
A128CBC_HS256 = ContentEncryption("A128CBC-HS256") // AES-CBC + HMAC-SHA256 (128)
|
||||||
|
A192CBC_HS384 = ContentEncryption("A192CBC-HS384") // AES-CBC + HMAC-SHA384 (192)
|
||||||
|
A256CBC_HS512 = ContentEncryption("A256CBC-HS512") // AES-CBC + HMAC-SHA512 (256)
|
||||||
|
A128GCM = ContentEncryption("A128GCM") // AES-GCM (128)
|
||||||
|
A192GCM = ContentEncryption("A192GCM") // AES-GCM (192)
|
||||||
|
A256GCM = ContentEncryption("A256GCM") // AES-GCM (256)
|
||||||
|
)
|
||||||
|
|
||||||
|
// Compression algorithms
|
||||||
|
const (
|
||||||
|
NONE = CompressionAlgorithm("") // No compression
|
||||||
|
DEFLATE = CompressionAlgorithm("DEF") // DEFLATE (RFC 1951)
|
||||||
|
)
|
||||||
|
|
||||||
|
// A key in the protected header of a JWS object. Use of the Header...
|
||||||
|
// constants is preferred to enhance type safety.
|
||||||
|
type HeaderKey string
|
||||||
|
|
||||||
|
const (
|
||||||
|
HeaderType = "typ" // string
|
||||||
|
HeaderContentType = "cty" // string
|
||||||
|
|
||||||
|
// These are set by go-jose and shouldn't need to be set by consumers of the
|
||||||
|
// library.
|
||||||
|
headerAlgorithm = "alg" // string
|
||||||
|
headerEncryption = "enc" // ContentEncryption
|
||||||
|
headerCompression = "zip" // CompressionAlgorithm
|
||||||
|
headerCritical = "crit" // []string
|
||||||
|
|
||||||
|
headerAPU = "apu" // *byteBuffer
|
||||||
|
headerAPV = "apv" // *byteBuffer
|
||||||
|
headerEPK = "epk" // *JSONWebKey
|
||||||
|
headerIV = "iv" // *byteBuffer
|
||||||
|
headerTag = "tag" // *byteBuffer
|
||||||
|
headerX5c = "x5c" // []*x509.Certificate
|
||||||
|
|
||||||
|
headerJWK = "jwk" // *JSONWebKey
|
||||||
|
headerKeyID = "kid" // string
|
||||||
|
headerNonce = "nonce" // string
|
||||||
|
headerB64 = "b64" // bool
|
||||||
|
|
||||||
|
headerP2C = "p2c" // *byteBuffer (int)
|
||||||
|
headerP2S = "p2s" // *byteBuffer ([]byte)
|
||||||
|
|
||||||
|
)
|
||||||
|
|
||||||
|
// supportedCritical is the set of supported extensions that are understood and processed.
|
||||||
|
var supportedCritical = map[string]bool{
|
||||||
|
headerB64: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
// rawHeader represents the JOSE header for JWE/JWS objects (used for parsing).
|
||||||
|
//
|
||||||
|
// The decoding of the constituent items is deferred because we want to marshal
|
||||||
|
// some members into particular structs rather than generic maps, but at the
|
||||||
|
// same time we need to receive any extra fields unhandled by this library to
|
||||||
|
// pass through to consuming code in case it wants to examine them.
|
||||||
|
type rawHeader map[HeaderKey]*json.RawMessage
|
||||||
|
|
||||||
|
// Header represents the read-only JOSE header for JWE/JWS objects.
|
||||||
|
type Header struct {
|
||||||
|
KeyID string
|
||||||
|
JSONWebKey *JSONWebKey
|
||||||
|
Algorithm string
|
||||||
|
Nonce string
|
||||||
|
|
||||||
|
// Unverified certificate chain parsed from x5c header.
|
||||||
|
certificates []*x509.Certificate
|
||||||
|
|
||||||
|
// At parse time, each header parameter with a name other than "kid",
|
||||||
|
// "jwk", "alg", "nonce", or "x5c" will have its value passed to
|
||||||
|
// [json.Unmarshal] to unmarshal it into an interface value.
|
||||||
|
// The resulting value will be stored in this map, with the header
|
||||||
|
// parameter name as the key.
|
||||||
|
//
|
||||||
|
// [json.Unmarshal]: https://pkg.go.dev/encoding/json#Unmarshal
|
||||||
|
ExtraHeaders map[HeaderKey]interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Certificates verifies & returns the certificate chain present
|
||||||
|
// in the x5c header field of a message, if one was present. Returns
|
||||||
|
// an error if there was no x5c header present or the chain could
|
||||||
|
// not be validated with the given verify options.
|
||||||
|
func (h Header) Certificates(opts x509.VerifyOptions) ([][]*x509.Certificate, error) {
|
||||||
|
if len(h.certificates) == 0 {
|
||||||
|
return nil, errors.New("go-jose/go-jose: no x5c header present in message")
|
||||||
|
}
|
||||||
|
|
||||||
|
leaf := h.certificates[0]
|
||||||
|
if opts.Intermediates == nil {
|
||||||
|
opts.Intermediates = x509.NewCertPool()
|
||||||
|
for _, intermediate := range h.certificates[1:] {
|
||||||
|
opts.Intermediates.AddCert(intermediate)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return leaf.Verify(opts)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (parsed rawHeader) set(k HeaderKey, v interface{}) error {
|
||||||
|
b, err := json.Marshal(v)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
parsed[k] = makeRawMessage(b)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getString gets a string from the raw JSON, defaulting to "".
|
||||||
|
func (parsed rawHeader) getString(k HeaderKey) string {
|
||||||
|
v, ok := parsed[k]
|
||||||
|
if !ok || v == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
var s string
|
||||||
|
err := json.Unmarshal(*v, &s)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// getByteBuffer gets a byte buffer from the raw JSON. Returns (nil, nil) if
|
||||||
|
// not specified.
|
||||||
|
func (parsed rawHeader) getByteBuffer(k HeaderKey) (*byteBuffer, error) {
|
||||||
|
v := parsed[k]
|
||||||
|
if v == nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
var bb *byteBuffer
|
||||||
|
err := json.Unmarshal(*v, &bb)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return bb, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getAlgorithm extracts parsed "alg" from the raw JSON as a KeyAlgorithm.
|
||||||
|
func (parsed rawHeader) getAlgorithm() KeyAlgorithm {
|
||||||
|
return KeyAlgorithm(parsed.getString(headerAlgorithm))
|
||||||
|
}
|
||||||
|
|
||||||
|
// getSignatureAlgorithm extracts parsed "alg" from the raw JSON as a SignatureAlgorithm.
|
||||||
|
func (parsed rawHeader) getSignatureAlgorithm() SignatureAlgorithm {
|
||||||
|
return SignatureAlgorithm(parsed.getString(headerAlgorithm))
|
||||||
|
}
|
||||||
|
|
||||||
|
// getEncryption extracts parsed "enc" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getEncryption() ContentEncryption {
|
||||||
|
return ContentEncryption(parsed.getString(headerEncryption))
|
||||||
|
}
|
||||||
|
|
||||||
|
// getCompression extracts parsed "zip" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getCompression() CompressionAlgorithm {
|
||||||
|
return CompressionAlgorithm(parsed.getString(headerCompression))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (parsed rawHeader) getNonce() string {
|
||||||
|
return parsed.getString(headerNonce)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getEPK extracts parsed "epk" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getEPK() (*JSONWebKey, error) {
|
||||||
|
v := parsed[headerEPK]
|
||||||
|
if v == nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
var epk *JSONWebKey
|
||||||
|
err := json.Unmarshal(*v, &epk)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return epk, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getAPU extracts parsed "apu" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getAPU() (*byteBuffer, error) {
|
||||||
|
return parsed.getByteBuffer(headerAPU)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getAPV extracts parsed "apv" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getAPV() (*byteBuffer, error) {
|
||||||
|
return parsed.getByteBuffer(headerAPV)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getIV extracts parsed "iv" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getIV() (*byteBuffer, error) {
|
||||||
|
return parsed.getByteBuffer(headerIV)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getTag extracts parsed "tag" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getTag() (*byteBuffer, error) {
|
||||||
|
return parsed.getByteBuffer(headerTag)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getJWK extracts parsed "jwk" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getJWK() (*JSONWebKey, error) {
|
||||||
|
v := parsed[headerJWK]
|
||||||
|
if v == nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
var jwk *JSONWebKey
|
||||||
|
err := json.Unmarshal(*v, &jwk)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return jwk, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getCritical extracts parsed "crit" from the raw JSON. If omitted, it
|
||||||
|
// returns an empty slice.
|
||||||
|
func (parsed rawHeader) getCritical() ([]string, error) {
|
||||||
|
v := parsed[headerCritical]
|
||||||
|
if v == nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var q []string
|
||||||
|
err := json.Unmarshal(*v, &q)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return q, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getS2C extracts parsed "p2c" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getP2C() (int, error) {
|
||||||
|
v := parsed[headerP2C]
|
||||||
|
if v == nil {
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var p2c int
|
||||||
|
err := json.Unmarshal(*v, &p2c)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return p2c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getS2S extracts parsed "p2s" from the raw JSON.
|
||||||
|
func (parsed rawHeader) getP2S() (*byteBuffer, error) {
|
||||||
|
return parsed.getByteBuffer(headerP2S)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getB64 extracts parsed "b64" from the raw JSON, defaulting to true.
|
||||||
|
func (parsed rawHeader) getB64() (bool, error) {
|
||||||
|
v := parsed[headerB64]
|
||||||
|
if v == nil {
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var b64 bool
|
||||||
|
err := json.Unmarshal(*v, &b64)
|
||||||
|
if err != nil {
|
||||||
|
return true, err
|
||||||
|
}
|
||||||
|
return b64, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// sanitized produces a cleaned-up header object from the raw JSON.
|
||||||
|
func (parsed rawHeader) sanitized() (h Header, err error) {
|
||||||
|
for k, v := range parsed {
|
||||||
|
if v == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch k {
|
||||||
|
case headerJWK:
|
||||||
|
var jwk *JSONWebKey
|
||||||
|
err = json.Unmarshal(*v, &jwk)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("failed to unmarshal JWK: %v: %#v", err, string(*v))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.JSONWebKey = jwk
|
||||||
|
case headerKeyID:
|
||||||
|
var s string
|
||||||
|
err = json.Unmarshal(*v, &s)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("failed to unmarshal key ID: %v: %#v", err, string(*v))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.KeyID = s
|
||||||
|
case headerAlgorithm:
|
||||||
|
var s string
|
||||||
|
err = json.Unmarshal(*v, &s)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("failed to unmarshal algorithm: %v: %#v", err, string(*v))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.Algorithm = s
|
||||||
|
case headerNonce:
|
||||||
|
var s string
|
||||||
|
err = json.Unmarshal(*v, &s)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("failed to unmarshal nonce: %v: %#v", err, string(*v))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.Nonce = s
|
||||||
|
case headerX5c:
|
||||||
|
c := []string{}
|
||||||
|
err = json.Unmarshal(*v, &c)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("failed to unmarshal x5c header: %v: %#v", err, string(*v))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.certificates, err = parseCertificateChain(c)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("failed to unmarshal x5c header: %v: %#v", err, string(*v))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
if h.ExtraHeaders == nil {
|
||||||
|
h.ExtraHeaders = map[HeaderKey]interface{}{}
|
||||||
|
}
|
||||||
|
var v2 interface{}
|
||||||
|
err = json.Unmarshal(*v, &v2)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("failed to unmarshal value: %v: %#v", err, string(*v))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.ExtraHeaders[k] = v2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseCertificateChain(chain []string) ([]*x509.Certificate, error) {
|
||||||
|
out := make([]*x509.Certificate, len(chain))
|
||||||
|
for i, cert := range chain {
|
||||||
|
raw, err := base64.StdEncoding.DecodeString(cert)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out[i], err = x509.ParseCertificate(raw)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (parsed rawHeader) isSet(k HeaderKey) bool {
|
||||||
|
dvr := parsed[k]
|
||||||
|
if dvr == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
var dv interface{}
|
||||||
|
err := json.Unmarshal(*dvr, &dv)
|
||||||
|
if err != nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if dvStr, ok := dv.(string); ok {
|
||||||
|
return dvStr != ""
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Merge headers from src into dst, giving precedence to headers from l.
|
||||||
|
func (parsed rawHeader) merge(src *rawHeader) {
|
||||||
|
if src == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range *src {
|
||||||
|
if parsed.isSet(k) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
parsed[k] = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get JOSE name of curve
|
||||||
|
func curveName(crv elliptic.Curve) (string, error) {
|
||||||
|
switch crv {
|
||||||
|
case elliptic.P256():
|
||||||
|
return "P-256", nil
|
||||||
|
case elliptic.P384():
|
||||||
|
return "P-384", nil
|
||||||
|
case elliptic.P521():
|
||||||
|
return "P-521", nil
|
||||||
|
default:
|
||||||
|
return "", fmt.Errorf("go-jose/go-jose: unsupported/unknown elliptic curve")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get size of curve in bytes
|
||||||
|
func curveSize(crv elliptic.Curve) int {
|
||||||
|
bits := crv.Params().BitSize
|
||||||
|
|
||||||
|
div := bits / 8
|
||||||
|
mod := bits % 8
|
||||||
|
|
||||||
|
if mod == 0 {
|
||||||
|
return div
|
||||||
|
}
|
||||||
|
|
||||||
|
return div + 1
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeRawMessage(b []byte) *json.RawMessage {
|
||||||
|
rm := json.RawMessage(b)
|
||||||
|
return &rm
|
||||||
|
}
|
|
@ -0,0 +1,487 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/ed25519"
|
||||||
|
"crypto/rsa"
|
||||||
|
"encoding/base64"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/go-jose/go-jose/v3/json"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NonceSource represents a source of random nonces to go into JWS objects
|
||||||
|
type NonceSource interface {
|
||||||
|
Nonce() (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Signer represents a signer which takes a payload and produces a signed JWS object.
|
||||||
|
type Signer interface {
|
||||||
|
Sign(payload []byte) (*JSONWebSignature, error)
|
||||||
|
Options() SignerOptions
|
||||||
|
}
|
||||||
|
|
||||||
|
// SigningKey represents an algorithm/key used to sign a message.
|
||||||
|
//
|
||||||
|
// Key must have one of these types:
|
||||||
|
// - ed25519.PrivateKey
|
||||||
|
// - *ecdsa.PrivateKey
|
||||||
|
// - *rsa.PrivateKey
|
||||||
|
// - *JSONWebKey
|
||||||
|
// - JSONWebKey
|
||||||
|
// - []byte (an HMAC key)
|
||||||
|
// - Any type that satisfies the OpaqueSigner interface
|
||||||
|
type SigningKey struct {
|
||||||
|
Algorithm SignatureAlgorithm
|
||||||
|
Key interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SignerOptions represents options that can be set when creating signers.
|
||||||
|
type SignerOptions struct {
|
||||||
|
NonceSource NonceSource
|
||||||
|
EmbedJWK bool
|
||||||
|
|
||||||
|
// Optional map of additional keys to be inserted into the protected header
|
||||||
|
// of a JWS object. Some specifications which make use of JWS like to insert
|
||||||
|
// additional values here.
|
||||||
|
//
|
||||||
|
// Values will be serialized by [json.Marshal] and must be valid inputs to
|
||||||
|
// that function.
|
||||||
|
//
|
||||||
|
// [json.Marshal]: https://pkg.go.dev/encoding/json#Marshal
|
||||||
|
ExtraHeaders map[HeaderKey]interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithHeader adds an arbitrary value to the ExtraHeaders map, initializing it
|
||||||
|
// if necessary, and returns the updated SignerOptions.
|
||||||
|
//
|
||||||
|
// The v argument will be serialized by [json.Marshal] and must be a valid
|
||||||
|
// input to that function.
|
||||||
|
//
|
||||||
|
// [json.Marshal]: https://pkg.go.dev/encoding/json#Marshal
|
||||||
|
func (so *SignerOptions) WithHeader(k HeaderKey, v interface{}) *SignerOptions {
|
||||||
|
if so.ExtraHeaders == nil {
|
||||||
|
so.ExtraHeaders = map[HeaderKey]interface{}{}
|
||||||
|
}
|
||||||
|
so.ExtraHeaders[k] = v
|
||||||
|
return so
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithContentType adds a content type ("cty") header and returns the updated
|
||||||
|
// SignerOptions.
|
||||||
|
func (so *SignerOptions) WithContentType(contentType ContentType) *SignerOptions {
|
||||||
|
return so.WithHeader(HeaderContentType, contentType)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithType adds a type ("typ") header and returns the updated SignerOptions.
|
||||||
|
func (so *SignerOptions) WithType(typ ContentType) *SignerOptions {
|
||||||
|
return so.WithHeader(HeaderType, typ)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithCritical adds the given names to the critical ("crit") header and returns
|
||||||
|
// the updated SignerOptions.
|
||||||
|
func (so *SignerOptions) WithCritical(names ...string) *SignerOptions {
|
||||||
|
if so.ExtraHeaders[headerCritical] == nil {
|
||||||
|
so.WithHeader(headerCritical, make([]string, 0, len(names)))
|
||||||
|
}
|
||||||
|
crit := so.ExtraHeaders[headerCritical].([]string)
|
||||||
|
so.ExtraHeaders[headerCritical] = append(crit, names...)
|
||||||
|
return so
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithBase64 adds a base64url-encode payload ("b64") header and returns the updated
|
||||||
|
// SignerOptions. When the "b64" value is "false", the payload is not base64 encoded.
|
||||||
|
func (so *SignerOptions) WithBase64(b64 bool) *SignerOptions {
|
||||||
|
if !b64 {
|
||||||
|
so.WithHeader(headerB64, b64)
|
||||||
|
so.WithCritical(headerB64)
|
||||||
|
}
|
||||||
|
return so
|
||||||
|
}
|
||||||
|
|
||||||
|
type payloadSigner interface {
|
||||||
|
signPayload(payload []byte, alg SignatureAlgorithm) (Signature, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type payloadVerifier interface {
|
||||||
|
verifyPayload(payload []byte, signature []byte, alg SignatureAlgorithm) error
|
||||||
|
}
|
||||||
|
|
||||||
|
type genericSigner struct {
|
||||||
|
recipients []recipientSigInfo
|
||||||
|
nonceSource NonceSource
|
||||||
|
embedJWK bool
|
||||||
|
extraHeaders map[HeaderKey]interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
type recipientSigInfo struct {
|
||||||
|
sigAlg SignatureAlgorithm
|
||||||
|
publicKey func() *JSONWebKey
|
||||||
|
signer payloadSigner
|
||||||
|
}
|
||||||
|
|
||||||
|
func staticPublicKey(jwk *JSONWebKey) func() *JSONWebKey {
|
||||||
|
return func() *JSONWebKey {
|
||||||
|
return jwk
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewSigner creates an appropriate signer based on the key type
|
||||||
|
func NewSigner(sig SigningKey, opts *SignerOptions) (Signer, error) {
|
||||||
|
return NewMultiSigner([]SigningKey{sig}, opts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewMultiSigner creates a signer for multiple recipients
|
||||||
|
func NewMultiSigner(sigs []SigningKey, opts *SignerOptions) (Signer, error) {
|
||||||
|
signer := &genericSigner{recipients: []recipientSigInfo{}}
|
||||||
|
|
||||||
|
if opts != nil {
|
||||||
|
signer.nonceSource = opts.NonceSource
|
||||||
|
signer.embedJWK = opts.EmbedJWK
|
||||||
|
signer.extraHeaders = opts.ExtraHeaders
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, sig := range sigs {
|
||||||
|
err := signer.addRecipient(sig.Algorithm, sig.Key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return signer, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// newVerifier creates a verifier based on the key type
|
||||||
|
func newVerifier(verificationKey interface{}) (payloadVerifier, error) {
|
||||||
|
switch verificationKey := verificationKey.(type) {
|
||||||
|
case ed25519.PublicKey:
|
||||||
|
return &edEncrypterVerifier{
|
||||||
|
publicKey: verificationKey,
|
||||||
|
}, nil
|
||||||
|
case *rsa.PublicKey:
|
||||||
|
return &rsaEncrypterVerifier{
|
||||||
|
publicKey: verificationKey,
|
||||||
|
}, nil
|
||||||
|
case *ecdsa.PublicKey:
|
||||||
|
return &ecEncrypterVerifier{
|
||||||
|
publicKey: verificationKey,
|
||||||
|
}, nil
|
||||||
|
case []byte:
|
||||||
|
return &symmetricMac{
|
||||||
|
key: verificationKey,
|
||||||
|
}, nil
|
||||||
|
case JSONWebKey:
|
||||||
|
return newVerifier(verificationKey.Key)
|
||||||
|
case *JSONWebKey:
|
||||||
|
return newVerifier(verificationKey.Key)
|
||||||
|
case OpaqueVerifier:
|
||||||
|
return &opaqueVerifier{verifier: verificationKey}, nil
|
||||||
|
default:
|
||||||
|
return nil, ErrUnsupportedKeyType
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *genericSigner) addRecipient(alg SignatureAlgorithm, signingKey interface{}) error {
|
||||||
|
recipient, err := makeJWSRecipient(alg, signingKey)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.recipients = append(ctx.recipients, recipient)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeJWSRecipient(alg SignatureAlgorithm, signingKey interface{}) (recipientSigInfo, error) {
|
||||||
|
switch signingKey := signingKey.(type) {
|
||||||
|
case ed25519.PrivateKey:
|
||||||
|
return newEd25519Signer(alg, signingKey)
|
||||||
|
case *rsa.PrivateKey:
|
||||||
|
return newRSASigner(alg, signingKey)
|
||||||
|
case *ecdsa.PrivateKey:
|
||||||
|
return newECDSASigner(alg, signingKey)
|
||||||
|
case []byte:
|
||||||
|
return newSymmetricSigner(alg, signingKey)
|
||||||
|
case JSONWebKey:
|
||||||
|
return newJWKSigner(alg, signingKey)
|
||||||
|
case *JSONWebKey:
|
||||||
|
return newJWKSigner(alg, *signingKey)
|
||||||
|
case OpaqueSigner:
|
||||||
|
return newOpaqueSigner(alg, signingKey)
|
||||||
|
default:
|
||||||
|
return recipientSigInfo{}, ErrUnsupportedKeyType
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newJWKSigner(alg SignatureAlgorithm, signingKey JSONWebKey) (recipientSigInfo, error) {
|
||||||
|
recipient, err := makeJWSRecipient(alg, signingKey.Key)
|
||||||
|
if err != nil {
|
||||||
|
return recipientSigInfo{}, err
|
||||||
|
}
|
||||||
|
if recipient.publicKey != nil && recipient.publicKey() != nil {
|
||||||
|
// recipient.publicKey is a JWK synthesized for embedding when recipientSigInfo
|
||||||
|
// was created for the inner key (such as a RSA or ECDSA public key). It contains
|
||||||
|
// the pub key for embedding, but doesn't have extra params like key id.
|
||||||
|
publicKey := signingKey
|
||||||
|
publicKey.Key = recipient.publicKey().Key
|
||||||
|
recipient.publicKey = staticPublicKey(&publicKey)
|
||||||
|
|
||||||
|
// This should be impossible, but let's check anyway.
|
||||||
|
if !recipient.publicKey().IsPublic() {
|
||||||
|
return recipientSigInfo{}, errors.New("go-jose/go-jose: public key was unexpectedly not public")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return recipient, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *genericSigner) Sign(payload []byte) (*JSONWebSignature, error) {
|
||||||
|
obj := &JSONWebSignature{}
|
||||||
|
obj.payload = payload
|
||||||
|
obj.Signatures = make([]Signature, len(ctx.recipients))
|
||||||
|
|
||||||
|
for i, recipient := range ctx.recipients {
|
||||||
|
protected := map[HeaderKey]interface{}{
|
||||||
|
headerAlgorithm: string(recipient.sigAlg),
|
||||||
|
}
|
||||||
|
|
||||||
|
if recipient.publicKey != nil && recipient.publicKey() != nil {
|
||||||
|
// We want to embed the JWK or set the kid header, but not both. Having a protected
|
||||||
|
// header that contains an embedded JWK while also simultaneously containing the kid
|
||||||
|
// header is confusing, and at least in ACME the two are considered to be mutually
|
||||||
|
// exclusive. The fact that both can exist at the same time is a somewhat unfortunate
|
||||||
|
// result of the JOSE spec. We've decided that this library will only include one or
|
||||||
|
// the other to avoid this confusion.
|
||||||
|
//
|
||||||
|
// See https://github.com/go-jose/go-jose/issues/157 for more context.
|
||||||
|
if ctx.embedJWK {
|
||||||
|
protected[headerJWK] = recipient.publicKey()
|
||||||
|
} else {
|
||||||
|
keyID := recipient.publicKey().KeyID
|
||||||
|
if keyID != "" {
|
||||||
|
protected[headerKeyID] = keyID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.nonceSource != nil {
|
||||||
|
nonce, err := ctx.nonceSource.Nonce()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: Error generating nonce: %v", err)
|
||||||
|
}
|
||||||
|
protected[headerNonce] = nonce
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range ctx.extraHeaders {
|
||||||
|
protected[k] = v
|
||||||
|
}
|
||||||
|
|
||||||
|
serializedProtected := mustSerializeJSON(protected)
|
||||||
|
needsBase64 := true
|
||||||
|
|
||||||
|
if b64, ok := protected[headerB64]; ok {
|
||||||
|
if needsBase64, ok = b64.(bool); !ok {
|
||||||
|
return nil, errors.New("go-jose/go-jose: Invalid b64 header parameter")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var input bytes.Buffer
|
||||||
|
|
||||||
|
input.WriteString(base64.RawURLEncoding.EncodeToString(serializedProtected))
|
||||||
|
input.WriteByte('.')
|
||||||
|
|
||||||
|
if needsBase64 {
|
||||||
|
input.WriteString(base64.RawURLEncoding.EncodeToString(payload))
|
||||||
|
} else {
|
||||||
|
input.Write(payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
signatureInfo, err := recipient.signer.signPayload(input.Bytes(), recipient.sigAlg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
signatureInfo.protected = &rawHeader{}
|
||||||
|
for k, v := range protected {
|
||||||
|
b, err := json.Marshal(v)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: Error marshalling item %#v: %v", k, err)
|
||||||
|
}
|
||||||
|
(*signatureInfo.protected)[k] = makeRawMessage(b)
|
||||||
|
}
|
||||||
|
obj.Signatures[i] = signatureInfo
|
||||||
|
}
|
||||||
|
|
||||||
|
return obj, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *genericSigner) Options() SignerOptions {
|
||||||
|
return SignerOptions{
|
||||||
|
NonceSource: ctx.nonceSource,
|
||||||
|
EmbedJWK: ctx.embedJWK,
|
||||||
|
ExtraHeaders: ctx.extraHeaders,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify validates the signature on the object and returns the payload.
|
||||||
|
// This function does not support multi-signature. If you desire multi-signature
|
||||||
|
// verification use VerifyMulti instead.
|
||||||
|
//
|
||||||
|
// Be careful when verifying signatures based on embedded JWKs inside the
|
||||||
|
// payload header. You cannot assume that the key received in a payload is
|
||||||
|
// trusted.
|
||||||
|
//
|
||||||
|
// The verificationKey argument must have one of these types:
|
||||||
|
// - ed25519.PublicKey
|
||||||
|
// - *ecdsa.PublicKey
|
||||||
|
// - *rsa.PublicKey
|
||||||
|
// - *JSONWebKey
|
||||||
|
// - JSONWebKey
|
||||||
|
// - []byte (an HMAC key)
|
||||||
|
// - Any type that implements the OpaqueVerifier interface.
|
||||||
|
func (obj JSONWebSignature) Verify(verificationKey interface{}) ([]byte, error) {
|
||||||
|
err := obj.DetachedVerify(obj.payload, verificationKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return obj.payload, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnsafePayloadWithoutVerification returns the payload without
|
||||||
|
// verifying it. The content returned from this function cannot be
|
||||||
|
// trusted.
|
||||||
|
func (obj JSONWebSignature) UnsafePayloadWithoutVerification() []byte {
|
||||||
|
return obj.payload
|
||||||
|
}
|
||||||
|
|
||||||
|
// DetachedVerify validates a detached signature on the given payload. In
|
||||||
|
// most cases, you will probably want to use Verify instead. DetachedVerify
|
||||||
|
// is only useful if you have a payload and signature that are separated from
|
||||||
|
// each other.
|
||||||
|
//
|
||||||
|
// The verificationKey argument must have one of the types allowed for the
|
||||||
|
// verificationKey argument of JSONWebSignature.Verify().
|
||||||
|
func (obj JSONWebSignature) DetachedVerify(payload []byte, verificationKey interface{}) error {
|
||||||
|
key := tryJWKS(verificationKey, obj.headers()...)
|
||||||
|
verifier, err := newVerifier(key)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(obj.Signatures) > 1 {
|
||||||
|
return errors.New("go-jose/go-jose: too many signatures in payload; expecting only one")
|
||||||
|
}
|
||||||
|
|
||||||
|
signature := obj.Signatures[0]
|
||||||
|
headers := signature.mergedHeaders()
|
||||||
|
critical, err := headers.getCritical()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, name := range critical {
|
||||||
|
if !supportedCritical[name] {
|
||||||
|
return ErrCryptoFailure
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
input, err := obj.computeAuthData(payload, &signature)
|
||||||
|
if err != nil {
|
||||||
|
return ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
alg := headers.getSignatureAlgorithm()
|
||||||
|
err = verifier.verifyPayload(input, signature.Signature, alg)
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyMulti validates (one of the multiple) signatures on the object and
|
||||||
|
// returns the index of the signature that was verified, along with the signature
|
||||||
|
// object and the payload. We return the signature and index to guarantee that
|
||||||
|
// callers are getting the verified value.
|
||||||
|
//
|
||||||
|
// The verificationKey argument must have one of the types allowed for the
|
||||||
|
// verificationKey argument of JSONWebSignature.Verify().
|
||||||
|
func (obj JSONWebSignature) VerifyMulti(verificationKey interface{}) (int, Signature, []byte, error) {
|
||||||
|
idx, sig, err := obj.DetachedVerifyMulti(obj.payload, verificationKey)
|
||||||
|
if err != nil {
|
||||||
|
return -1, Signature{}, nil, err
|
||||||
|
}
|
||||||
|
return idx, sig, obj.payload, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DetachedVerifyMulti validates a detached signature on the given payload with
|
||||||
|
// a signature/object that has potentially multiple signers. This returns the index
|
||||||
|
// of the signature that was verified, along with the signature object. We return
|
||||||
|
// the signature and index to guarantee that callers are getting the verified value.
|
||||||
|
//
|
||||||
|
// In most cases, you will probably want to use Verify or VerifyMulti instead.
|
||||||
|
// DetachedVerifyMulti is only useful if you have a payload and signature that are
|
||||||
|
// separated from each other, and the signature can have multiple signers at the
|
||||||
|
// same time.
|
||||||
|
//
|
||||||
|
// The verificationKey argument must have one of the types allowed for the
|
||||||
|
// verificationKey argument of JSONWebSignature.Verify().
|
||||||
|
func (obj JSONWebSignature) DetachedVerifyMulti(payload []byte, verificationKey interface{}) (int, Signature, error) {
|
||||||
|
key := tryJWKS(verificationKey, obj.headers()...)
|
||||||
|
verifier, err := newVerifier(key)
|
||||||
|
if err != nil {
|
||||||
|
return -1, Signature{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
outer:
|
||||||
|
for i, signature := range obj.Signatures {
|
||||||
|
headers := signature.mergedHeaders()
|
||||||
|
critical, err := headers.getCritical()
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, name := range critical {
|
||||||
|
if !supportedCritical[name] {
|
||||||
|
continue outer
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
input, err := obj.computeAuthData(payload, &signature)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
alg := headers.getSignatureAlgorithm()
|
||||||
|
err = verifier.verifyPayload(input, signature.Signature, alg)
|
||||||
|
if err == nil {
|
||||||
|
return i, signature, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return -1, Signature{}, ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
func (obj JSONWebSignature) headers() []Header {
|
||||||
|
headers := make([]Header, len(obj.Signatures))
|
||||||
|
for i, sig := range obj.Signatures {
|
||||||
|
headers[i] = sig.Header
|
||||||
|
}
|
||||||
|
return headers
|
||||||
|
}
|
|
@ -0,0 +1,505 @@
|
||||||
|
/*-
|
||||||
|
* Copyright 2014 Square Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package jose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/aes"
|
||||||
|
"crypto/cipher"
|
||||||
|
"crypto/hmac"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/sha256"
|
||||||
|
"crypto/sha512"
|
||||||
|
"crypto/subtle"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"hash"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"golang.org/x/crypto/pbkdf2"
|
||||||
|
|
||||||
|
josecipher "github.com/go-jose/go-jose/v3/cipher"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RandReader is a cryptographically secure random number generator (stubbed out in tests).
|
||||||
|
var RandReader = rand.Reader
|
||||||
|
|
||||||
|
const (
|
||||||
|
// RFC7518 recommends a minimum of 1,000 iterations:
|
||||||
|
// - https://tools.ietf.org/html/rfc7518#section-4.8.1.2
|
||||||
|
//
|
||||||
|
// NIST recommends a minimum of 10,000:
|
||||||
|
// - https://pages.nist.gov/800-63-3/sp800-63b.html
|
||||||
|
//
|
||||||
|
// 1Password increased in 2023 from 100,000 to 650,000:
|
||||||
|
// - https://support.1password.com/pbkdf2/
|
||||||
|
//
|
||||||
|
// OWASP recommended 600,000 in Dec 2022:
|
||||||
|
// - https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#pbkdf2
|
||||||
|
defaultP2C = 600000
|
||||||
|
// Default salt size: 128 bits
|
||||||
|
defaultP2SSize = 16
|
||||||
|
)
|
||||||
|
|
||||||
|
// Dummy key cipher for shared symmetric key mode
|
||||||
|
type symmetricKeyCipher struct {
|
||||||
|
key []byte // Pre-shared content-encryption key
|
||||||
|
p2c int // PBES2 Count
|
||||||
|
p2s []byte // PBES2 Salt Input
|
||||||
|
}
|
||||||
|
|
||||||
|
// Signer/verifier for MAC modes
|
||||||
|
type symmetricMac struct {
|
||||||
|
key []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// Input/output from an AEAD operation
|
||||||
|
type aeadParts struct {
|
||||||
|
iv, ciphertext, tag []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// A content cipher based on an AEAD construction
|
||||||
|
type aeadContentCipher struct {
|
||||||
|
keyBytes int
|
||||||
|
authtagBytes int
|
||||||
|
getAead func(key []byte) (cipher.AEAD, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Random key generator
|
||||||
|
type randomKeyGenerator struct {
|
||||||
|
size int
|
||||||
|
}
|
||||||
|
|
||||||
|
// Static key generator
|
||||||
|
type staticKeyGenerator struct {
|
||||||
|
key []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a new content cipher based on AES-GCM
|
||||||
|
func newAESGCM(keySize int) contentCipher {
|
||||||
|
return &aeadContentCipher{
|
||||||
|
keyBytes: keySize,
|
||||||
|
authtagBytes: 16,
|
||||||
|
getAead: func(key []byte) (cipher.AEAD, error) {
|
||||||
|
aes, err := aes.NewCipher(key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return cipher.NewGCM(aes)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a new content cipher based on AES-CBC+HMAC
|
||||||
|
func newAESCBC(keySize int) contentCipher {
|
||||||
|
return &aeadContentCipher{
|
||||||
|
keyBytes: keySize * 2,
|
||||||
|
authtagBytes: keySize,
|
||||||
|
getAead: func(key []byte) (cipher.AEAD, error) {
|
||||||
|
return josecipher.NewCBCHMAC(key, aes.NewCipher)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get an AEAD cipher object for the given content encryption algorithm
|
||||||
|
func getContentCipher(alg ContentEncryption) contentCipher {
|
||||||
|
switch alg {
|
||||||
|
case A128GCM:
|
||||||
|
return newAESGCM(16)
|
||||||
|
case A192GCM:
|
||||||
|
return newAESGCM(24)
|
||||||
|
case A256GCM:
|
||||||
|
return newAESGCM(32)
|
||||||
|
case A128CBC_HS256:
|
||||||
|
return newAESCBC(16)
|
||||||
|
case A192CBC_HS384:
|
||||||
|
return newAESCBC(24)
|
||||||
|
case A256CBC_HS512:
|
||||||
|
return newAESCBC(32)
|
||||||
|
default:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// getPbkdf2Params returns the key length and hash function used in
|
||||||
|
// pbkdf2.Key.
|
||||||
|
func getPbkdf2Params(alg KeyAlgorithm) (int, func() hash.Hash) {
|
||||||
|
switch alg {
|
||||||
|
case PBES2_HS256_A128KW:
|
||||||
|
return 16, sha256.New
|
||||||
|
case PBES2_HS384_A192KW:
|
||||||
|
return 24, sha512.New384
|
||||||
|
case PBES2_HS512_A256KW:
|
||||||
|
return 32, sha512.New
|
||||||
|
default:
|
||||||
|
panic("invalid algorithm")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// getRandomSalt generates a new salt of the given size.
|
||||||
|
func getRandomSalt(size int) ([]byte, error) {
|
||||||
|
salt := make([]byte, size)
|
||||||
|
_, err := io.ReadFull(RandReader, salt)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return salt, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// newSymmetricRecipient creates a JWE encrypter based on AES-GCM key wrap.
|
||||||
|
func newSymmetricRecipient(keyAlg KeyAlgorithm, key []byte) (recipientKeyInfo, error) {
|
||||||
|
switch keyAlg {
|
||||||
|
case DIRECT, A128GCMKW, A192GCMKW, A256GCMKW, A128KW, A192KW, A256KW:
|
||||||
|
case PBES2_HS256_A128KW, PBES2_HS384_A192KW, PBES2_HS512_A256KW:
|
||||||
|
default:
|
||||||
|
return recipientKeyInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientKeyInfo{
|
||||||
|
keyAlg: keyAlg,
|
||||||
|
keyEncrypter: &symmetricKeyCipher{
|
||||||
|
key: key,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// newSymmetricSigner creates a recipientSigInfo based on the given key.
|
||||||
|
func newSymmetricSigner(sigAlg SignatureAlgorithm, key []byte) (recipientSigInfo, error) {
|
||||||
|
// Verify that key management algorithm is supported by this encrypter
|
||||||
|
switch sigAlg {
|
||||||
|
case HS256, HS384, HS512:
|
||||||
|
default:
|
||||||
|
return recipientSigInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientSigInfo{
|
||||||
|
sigAlg: sigAlg,
|
||||||
|
signer: &symmetricMac{
|
||||||
|
key: key,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generate a random key for the given content cipher
|
||||||
|
func (ctx randomKeyGenerator) genKey() ([]byte, rawHeader, error) {
|
||||||
|
key := make([]byte, ctx.size)
|
||||||
|
_, err := io.ReadFull(RandReader, key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, rawHeader{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return key, rawHeader{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Key size for random generator
|
||||||
|
func (ctx randomKeyGenerator) keySize() int {
|
||||||
|
return ctx.size
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generate a static key (for direct mode)
|
||||||
|
func (ctx staticKeyGenerator) genKey() ([]byte, rawHeader, error) {
|
||||||
|
cek := make([]byte, len(ctx.key))
|
||||||
|
copy(cek, ctx.key)
|
||||||
|
return cek, rawHeader{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Key size for static generator
|
||||||
|
func (ctx staticKeyGenerator) keySize() int {
|
||||||
|
return len(ctx.key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get key size for this cipher
|
||||||
|
func (ctx aeadContentCipher) keySize() int {
|
||||||
|
return ctx.keyBytes
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt some data
|
||||||
|
func (ctx aeadContentCipher) encrypt(key, aad, pt []byte) (*aeadParts, error) {
|
||||||
|
// Get a new AEAD instance
|
||||||
|
aead, err := ctx.getAead(key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initialize a new nonce
|
||||||
|
iv := make([]byte, aead.NonceSize())
|
||||||
|
_, err = io.ReadFull(RandReader, iv)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
ciphertextAndTag := aead.Seal(nil, iv, pt, aad)
|
||||||
|
offset := len(ciphertextAndTag) - ctx.authtagBytes
|
||||||
|
|
||||||
|
return &aeadParts{
|
||||||
|
iv: iv,
|
||||||
|
ciphertext: ciphertextAndTag[:offset],
|
||||||
|
tag: ciphertextAndTag[offset:],
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt some data
|
||||||
|
func (ctx aeadContentCipher) decrypt(key, aad []byte, parts *aeadParts) ([]byte, error) {
|
||||||
|
aead, err := ctx.getAead(key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(parts.iv) != aead.NonceSize() || len(parts.tag) < ctx.authtagBytes {
|
||||||
|
return nil, ErrCryptoFailure
|
||||||
|
}
|
||||||
|
|
||||||
|
return aead.Open(nil, parts.iv, append(parts.ciphertext, parts.tag...), aad)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encrypt the content encryption key.
|
||||||
|
func (ctx *symmetricKeyCipher) encryptKey(cek []byte, alg KeyAlgorithm) (recipientInfo, error) {
|
||||||
|
switch alg {
|
||||||
|
case DIRECT:
|
||||||
|
return recipientInfo{
|
||||||
|
header: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
case A128GCMKW, A192GCMKW, A256GCMKW:
|
||||||
|
aead := newAESGCM(len(ctx.key))
|
||||||
|
|
||||||
|
parts, err := aead.encrypt(ctx.key, []byte{}, cek)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
header := &rawHeader{}
|
||||||
|
|
||||||
|
if err = header.set(headerIV, newBuffer(parts.iv)); err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err = header.set(headerTag, newBuffer(parts.tag)); err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientInfo{
|
||||||
|
header: header,
|
||||||
|
encryptedKey: parts.ciphertext,
|
||||||
|
}, nil
|
||||||
|
case A128KW, A192KW, A256KW:
|
||||||
|
block, err := aes.NewCipher(ctx.key)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
jek, err := josecipher.KeyWrap(block, cek)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientInfo{
|
||||||
|
encryptedKey: jek,
|
||||||
|
header: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
case PBES2_HS256_A128KW, PBES2_HS384_A192KW, PBES2_HS512_A256KW:
|
||||||
|
if len(ctx.p2s) == 0 {
|
||||||
|
salt, err := getRandomSalt(defaultP2SSize)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
ctx.p2s = salt
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.p2c <= 0 {
|
||||||
|
ctx.p2c = defaultP2C
|
||||||
|
}
|
||||||
|
|
||||||
|
// salt is UTF8(Alg) || 0x00 || Salt Input
|
||||||
|
salt := bytes.Join([][]byte{[]byte(alg), ctx.p2s}, []byte{0x00})
|
||||||
|
|
||||||
|
// derive key
|
||||||
|
keyLen, h := getPbkdf2Params(alg)
|
||||||
|
key := pbkdf2.Key(ctx.key, salt, ctx.p2c, keyLen, h)
|
||||||
|
|
||||||
|
// use AES cipher with derived key
|
||||||
|
block, err := aes.NewCipher(key)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
jek, err := josecipher.KeyWrap(block, cek)
|
||||||
|
if err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
header := &rawHeader{}
|
||||||
|
|
||||||
|
if err = header.set(headerP2C, ctx.p2c); err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err = header.set(headerP2S, newBuffer(ctx.p2s)); err != nil {
|
||||||
|
return recipientInfo{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientInfo{
|
||||||
|
encryptedKey: jek,
|
||||||
|
header: header,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return recipientInfo{}, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decrypt the content encryption key.
|
||||||
|
func (ctx *symmetricKeyCipher) decryptKey(headers rawHeader, recipient *recipientInfo, generator keyGenerator) ([]byte, error) {
|
||||||
|
switch headers.getAlgorithm() {
|
||||||
|
case DIRECT:
|
||||||
|
cek := make([]byte, len(ctx.key))
|
||||||
|
copy(cek, ctx.key)
|
||||||
|
return cek, nil
|
||||||
|
case A128GCMKW, A192GCMKW, A256GCMKW:
|
||||||
|
aead := newAESGCM(len(ctx.key))
|
||||||
|
|
||||||
|
iv, err := headers.getIV()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid IV: %v", err)
|
||||||
|
}
|
||||||
|
tag, err := headers.getTag()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid tag: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := &aeadParts{
|
||||||
|
iv: iv.bytes(),
|
||||||
|
ciphertext: recipient.encryptedKey,
|
||||||
|
tag: tag.bytes(),
|
||||||
|
}
|
||||||
|
|
||||||
|
cek, err := aead.decrypt(ctx.key, []byte{}, parts)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return cek, nil
|
||||||
|
case A128KW, A192KW, A256KW:
|
||||||
|
block, err := aes.NewCipher(ctx.key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
cek, err := josecipher.KeyUnwrap(block, recipient.encryptedKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return cek, nil
|
||||||
|
case PBES2_HS256_A128KW, PBES2_HS384_A192KW, PBES2_HS512_A256KW:
|
||||||
|
p2s, err := headers.getP2S()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid P2S: %v", err)
|
||||||
|
}
|
||||||
|
if p2s == nil || len(p2s.data) == 0 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid P2S: must be present")
|
||||||
|
}
|
||||||
|
|
||||||
|
p2c, err := headers.getP2C()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid P2C: %v", err)
|
||||||
|
}
|
||||||
|
if p2c <= 0 {
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid P2C: must be a positive integer")
|
||||||
|
}
|
||||||
|
if p2c > 1000000 {
|
||||||
|
// An unauthenticated attacker can set a high P2C value. Set an upper limit to avoid
|
||||||
|
// DoS attacks.
|
||||||
|
return nil, fmt.Errorf("go-jose/go-jose: invalid P2C: too high")
|
||||||
|
}
|
||||||
|
|
||||||
|
// salt is UTF8(Alg) || 0x00 || Salt Input
|
||||||
|
alg := headers.getAlgorithm()
|
||||||
|
salt := bytes.Join([][]byte{[]byte(alg), p2s.bytes()}, []byte{0x00})
|
||||||
|
|
||||||
|
// derive key
|
||||||
|
keyLen, h := getPbkdf2Params(alg)
|
||||||
|
key := pbkdf2.Key(ctx.key, salt, p2c, keyLen, h)
|
||||||
|
|
||||||
|
// use AES cipher with derived key
|
||||||
|
block, err := aes.NewCipher(key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
cek, err := josecipher.KeyUnwrap(block, recipient.encryptedKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return cek, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sign the given payload
|
||||||
|
func (ctx symmetricMac) signPayload(payload []byte, alg SignatureAlgorithm) (Signature, error) {
|
||||||
|
mac, err := ctx.hmac(payload, alg)
|
||||||
|
if err != nil {
|
||||||
|
return Signature{}, errors.New("go-jose/go-jose: failed to compute hmac")
|
||||||
|
}
|
||||||
|
|
||||||
|
return Signature{
|
||||||
|
Signature: mac,
|
||||||
|
protected: &rawHeader{},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify the given payload
|
||||||
|
func (ctx symmetricMac) verifyPayload(payload []byte, mac []byte, alg SignatureAlgorithm) error {
|
||||||
|
expected, err := ctx.hmac(payload, alg)
|
||||||
|
if err != nil {
|
||||||
|
return errors.New("go-jose/go-jose: failed to compute hmac")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(mac) != len(expected) {
|
||||||
|
return errors.New("go-jose/go-jose: invalid hmac")
|
||||||
|
}
|
||||||
|
|
||||||
|
match := subtle.ConstantTimeCompare(mac, expected)
|
||||||
|
if match != 1 {
|
||||||
|
return errors.New("go-jose/go-jose: invalid hmac")
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compute the HMAC based on the given alg value
|
||||||
|
func (ctx symmetricMac) hmac(payload []byte, alg SignatureAlgorithm) ([]byte, error) {
|
||||||
|
var hash func() hash.Hash
|
||||||
|
|
||||||
|
switch alg {
|
||||||
|
case HS256:
|
||||||
|
hash = sha256.New
|
||||||
|
case HS384:
|
||||||
|
hash = sha512.New384
|
||||||
|
case HS512:
|
||||||
|
hash = sha512.New
|
||||||
|
default:
|
||||||
|
return nil, ErrUnsupportedAlgorithm
|
||||||
|
}
|
||||||
|
|
||||||
|
hmac := hmac.New(hash, ctx.key)
|
||||||
|
|
||||||
|
// According to documentation, Write() on hash never fails
|
||||||
|
_, _ = hmac.Write(payload)
|
||||||
|
return hmac.Sum(nil), nil
|
||||||
|
}
|
|
@ -0,0 +1,23 @@
|
||||||
|
Copyright (c) 2014, Dave Cheney <dave@cheney.net>
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
* Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation
|
||||||
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||||
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@ -0,0 +1,55 @@
|
||||||
|
|
||||||
|
# browser
|
||||||
|
import "github.com/pkg/browser"
|
||||||
|
|
||||||
|
Package browser provides helpers to open files, readers, and urls in a browser window.
|
||||||
|
|
||||||
|
The choice of which browser is started is entirely client dependant.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Variables
|
||||||
|
``` go
|
||||||
|
var Stderr io.Writer = os.Stderr
|
||||||
|
```
|
||||||
|
Stderr is the io.Writer to which executed commands write standard error.
|
||||||
|
|
||||||
|
``` go
|
||||||
|
var Stdout io.Writer = os.Stdout
|
||||||
|
```
|
||||||
|
Stdout is the io.Writer to which executed commands write standard output.
|
||||||
|
|
||||||
|
|
||||||
|
## func OpenFile
|
||||||
|
``` go
|
||||||
|
func OpenFile(path string) error
|
||||||
|
```
|
||||||
|
OpenFile opens new browser window for the file path.
|
||||||
|
|
||||||
|
|
||||||
|
## func OpenReader
|
||||||
|
``` go
|
||||||
|
func OpenReader(r io.Reader) error
|
||||||
|
```
|
||||||
|
OpenReader consumes the contents of r and presents the
|
||||||
|
results in a new browser window.
|
||||||
|
|
||||||
|
|
||||||
|
## func OpenURL
|
||||||
|
``` go
|
||||||
|
func OpenURL(url string) error
|
||||||
|
```
|
||||||
|
OpenURL opens a new browser window pointing to url.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- - -
|
||||||
|
Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)
|
|
@ -0,0 +1,57 @@
|
||||||
|
// Package browser provides helpers to open files, readers, and urls in a browser window.
|
||||||
|
//
|
||||||
|
// The choice of which browser is started is entirely client dependant.
|
||||||
|
package browser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Stdout is the io.Writer to which executed commands write standard output.
|
||||||
|
var Stdout io.Writer = os.Stdout
|
||||||
|
|
||||||
|
// Stderr is the io.Writer to which executed commands write standard error.
|
||||||
|
var Stderr io.Writer = os.Stderr
|
||||||
|
|
||||||
|
// OpenFile opens new browser window for the file path.
|
||||||
|
func OpenFile(path string) error {
|
||||||
|
path, err := filepath.Abs(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return OpenURL("file://" + path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpenReader consumes the contents of r and presents the
|
||||||
|
// results in a new browser window.
|
||||||
|
func OpenReader(r io.Reader) error {
|
||||||
|
f, err := ioutil.TempFile("", "browser.*.html")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("browser: could not create temporary file: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := io.Copy(f, r); err != nil {
|
||||||
|
f.Close()
|
||||||
|
return fmt.Errorf("browser: caching temporary file failed: %v", err)
|
||||||
|
}
|
||||||
|
if err := f.Close(); err != nil {
|
||||||
|
return fmt.Errorf("browser: caching temporary file failed: %v", err)
|
||||||
|
}
|
||||||
|
return OpenFile(f.Name())
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpenURL opens a new browser window pointing to url.
|
||||||
|
func OpenURL(url string) error {
|
||||||
|
return openBrowser(url)
|
||||||
|
}
|
||||||
|
|
||||||
|
func runCmd(prog string, args ...string) error {
|
||||||
|
cmd := exec.Command(prog, args...)
|
||||||
|
cmd.Stdout = Stdout
|
||||||
|
cmd.Stderr = Stderr
|
||||||
|
return cmd.Run()
|
||||||
|
}
|
|
@ -0,0 +1,5 @@
|
||||||
|
package browser
|
||||||
|
|
||||||
|
func openBrowser(url string) error {
|
||||||
|
return runCmd("open", url)
|
||||||
|
}
|
|
@ -0,0 +1,14 @@
|
||||||
|
package browser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os/exec"
|
||||||
|
)
|
||||||
|
|
||||||
|
func openBrowser(url string) error {
|
||||||
|
err := runCmd("xdg-open", url)
|
||||||
|
if e, ok := err.(*exec.Error); ok && e.Err == exec.ErrNotFound {
|
||||||
|
return errors.New("xdg-open: command not found - install xdg-utils from ports(8)")
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
|
@ -0,0 +1,21 @@
|
||||||
|
package browser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
func openBrowser(url string) error {
|
||||||
|
providers := []string{"xdg-open", "x-www-browser", "www-browser"}
|
||||||
|
|
||||||
|
// There are multiple possible providers to open a browser on linux
|
||||||
|
// One of them is xdg-open, another is x-www-browser, then there's www-browser, etc.
|
||||||
|
// Look for one that exists and run it
|
||||||
|
for _, provider := range providers {
|
||||||
|
if _, err := exec.LookPath(provider); err == nil {
|
||||||
|
return runCmd(provider, url)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return &exec.Error{Name: strings.Join(providers, ","), Err: exec.ErrNotFound}
|
||||||
|
}
|
|
@ -0,0 +1,14 @@
|
||||||
|
package browser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os/exec"
|
||||||
|
)
|
||||||
|
|
||||||
|
func openBrowser(url string) error {
|
||||||
|
err := runCmd("xdg-open", url)
|
||||||
|
if e, ok := err.(*exec.Error); ok && e.Err == exec.ErrNotFound {
|
||||||
|
return errors.New("xdg-open: command not found - install xdg-utils from pkgsrc(7)")
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
|
@ -0,0 +1,14 @@
|
||||||
|
package browser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os/exec"
|
||||||
|
)
|
||||||
|
|
||||||
|
func openBrowser(url string) error {
|
||||||
|
err := runCmd("xdg-open", url)
|
||||||
|
if e, ok := err.(*exec.Error); ok && e.Err == exec.ErrNotFound {
|
||||||
|
return errors.New("xdg-open: command not found - install xdg-utils from ports(8)")
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
|
@ -0,0 +1,12 @@
|
||||||
|
// +build !linux,!windows,!darwin,!openbsd,!freebsd,!netbsd
|
||||||
|
|
||||||
|
package browser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"runtime"
|
||||||
|
)
|
||||||
|
|
||||||
|
func openBrowser(url string) error {
|
||||||
|
return fmt.Errorf("openBrowser: unsupported operating system: %v", runtime.GOOS)
|
||||||
|
}
|
|
@ -0,0 +1,7 @@
|
||||||
|
package browser
|
||||||
|
|
||||||
|
import "golang.org/x/sys/windows"
|
||||||
|
|
||||||
|
func openBrowser(url string) error {
|
||||||
|
return windows.ShellExecute(0, nil, windows.StringToUTF16Ptr(url), nil, nil, windows.SW_SHOWNORMAL)
|
||||||
|
}
|
|
@ -123,6 +123,12 @@ github.com/felixge/httpsnoop
|
||||||
# github.com/fvbommel/sortorder v1.1.0
|
# github.com/fvbommel/sortorder v1.1.0
|
||||||
## explicit; go 1.13
|
## explicit; go 1.13
|
||||||
github.com/fvbommel/sortorder
|
github.com/fvbommel/sortorder
|
||||||
|
# github.com/go-jose/go-jose/v3 v3.0.3
|
||||||
|
## explicit; go 1.12
|
||||||
|
github.com/go-jose/go-jose/v3
|
||||||
|
github.com/go-jose/go-jose/v3/cipher
|
||||||
|
github.com/go-jose/go-jose/v3/json
|
||||||
|
github.com/go-jose/go-jose/v3/jwt
|
||||||
# github.com/go-logr/logr v1.4.1
|
# github.com/go-logr/logr v1.4.1
|
||||||
## explicit; go 1.18
|
## explicit; go 1.18
|
||||||
github.com/go-logr/logr
|
github.com/go-logr/logr
|
||||||
|
@ -233,6 +239,9 @@ github.com/opencontainers/go-digest
|
||||||
## explicit; go 1.18
|
## explicit; go 1.18
|
||||||
github.com/opencontainers/image-spec/specs-go
|
github.com/opencontainers/image-spec/specs-go
|
||||||
github.com/opencontainers/image-spec/specs-go/v1
|
github.com/opencontainers/image-spec/specs-go/v1
|
||||||
|
# github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c
|
||||||
|
## explicit; go 1.14
|
||||||
|
github.com/pkg/browser
|
||||||
# github.com/pkg/errors v0.9.1
|
# github.com/pkg/errors v0.9.1
|
||||||
## explicit
|
## explicit
|
||||||
github.com/pkg/errors
|
github.com/pkg/errors
|
||||||
|
@ -266,6 +275,8 @@ github.com/spf13/cobra
|
||||||
# github.com/spf13/pflag v1.0.5
|
# github.com/spf13/pflag v1.0.5
|
||||||
## explicit; go 1.12
|
## explicit; go 1.12
|
||||||
github.com/spf13/pflag
|
github.com/spf13/pflag
|
||||||
|
# github.com/stretchr/testify v1.9.0
|
||||||
|
## explicit; go 1.17
|
||||||
# github.com/theupdateframework/notary v0.7.1-0.20210315103452-bf96a202a09a
|
# github.com/theupdateframework/notary v0.7.1-0.20210315103452-bf96a202a09a
|
||||||
## explicit; go 1.12
|
## explicit; go 1.12
|
||||||
github.com/theupdateframework/notary
|
github.com/theupdateframework/notary
|
||||||
|
|
Loading…
Reference in New Issue