1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
|
// Copyright 2024 OpenPubkey
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0
package providers
import (
"context"
"fmt"
"net/http"
"os"
"github.com/openpubkey/openpubkey/discover"
simpleoidc "github.com/openpubkey/openpubkey/oidc"
"github.com/openpubkey/openpubkey/pktoken/clientinstance"
)
// Interface for interacting with the OP (OpenID Provider) that only returns
// an ID Token
type OpenIdProvider interface {
RequestTokens(ctx context.Context, cic *clientinstance.Claims) (*simpleoidc.Tokens, error)
PublicKeyByKeyId(ctx context.Context, keyID string) (*discover.PublicKeyRecord, error)
PublicKeyByToken(ctx context.Context, token []byte) (*discover.PublicKeyRecord, error)
// Returns the OpenID provider issuer as seen in ID token e.g. "https://accounts.google.com"
Issuer() string
VerifyIDToken(ctx context.Context, idt []byte, cic *clientinstance.Claims) error
}
type BrowserOpenIdProvider interface {
OpenIdProvider
ClientID() string
HookHTTPSession(h http.HandlerFunc)
ReuseBrowserWindowHook(chan string)
}
// Interface for an OpenIdProvider that returns an ID Token, Refresh Token and Access Token
type RefreshableOpenIdProvider interface {
OpenIdProvider
RefreshTokens(ctx context.Context, refreshToken []byte) (*simpleoidc.Tokens, error)
VerifyRefreshedIDToken(ctx context.Context, origIdt []byte, reIdt []byte) error
}
type CommitType struct {
Claim string
GQCommitment bool
}
var CommitTypesEnum = struct {
NONCE_CLAIM CommitType
AUD_CLAIM CommitType
GQ_BOUND CommitType
}{
NONCE_CLAIM: CommitType{Claim: "nonce", GQCommitment: false},
AUD_CLAIM: CommitType{Claim: "aud", GQCommitment: false},
GQ_BOUND: CommitType{Claim: "", GQCommitment: true}, // The commitmentClaim is bound to the ID Token using only the GQ signature
}
func getEnvVar(name string) (string, error) {
value, ok := os.LookupEnv(name)
if !ok {
return "", fmt.Errorf("%q environment variable not set", name)
}
return value, nil
}
|