|
| 1 | +package oidc |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "encoding/json" |
| 6 | + "errors" |
| 7 | + "fmt" |
| 8 | + "time" |
| 9 | + |
| 10 | + "github.com/99designs/keyring" |
| 11 | + "golang.org/x/oauth2" |
| 12 | + |
| 13 | + log "github.com/armadaproject/armada/internal/common/logging" |
| 14 | +) |
| 15 | + |
| 16 | +const ( |
| 17 | + keyringServiceName = "armada-oidc" |
| 18 | +) |
| 19 | + |
| 20 | +var errCacheNotInitialized = errors.New("token cache not initialized") |
| 21 | + |
| 22 | +type tokenCache struct { |
| 23 | + ring keyring.Keyring |
| 24 | + providerUrl string |
| 25 | + clientId string |
| 26 | +} |
| 27 | + |
| 28 | +type cachedToken struct { |
| 29 | + RefreshToken string `json:"refresh_token"` |
| 30 | +} |
| 31 | + |
| 32 | +func newTokenCache(providerUrl, clientId string) (*tokenCache, error) { |
| 33 | + ring, err := keyring.Open(keyring.Config{ |
| 34 | + ServiceName: keyringServiceName, |
| 35 | + AllowedBackends: keyring.AvailableBackends(), |
| 36 | + KeychainTrustApplication: true, |
| 37 | + KeychainSynchronizable: false, |
| 38 | + KeychainAccessibleWhenUnlocked: true, |
| 39 | + KWalletAppID: "armada", |
| 40 | + KWalletFolder: "armada", |
| 41 | + LibSecretCollectionName: "armada", |
| 42 | + WinCredPrefix: "armada", |
| 43 | + }) |
| 44 | + if err != nil { |
| 45 | + return nil, fmt.Errorf("no secure keyring backend available: %w", err) |
| 46 | + } |
| 47 | + |
| 48 | + return &tokenCache{ |
| 49 | + ring: ring, |
| 50 | + providerUrl: providerUrl, |
| 51 | + clientId: clientId, |
| 52 | + }, nil |
| 53 | +} |
| 54 | + |
| 55 | +func (tc *tokenCache) getKey() string { |
| 56 | + return fmt.Sprintf("%s:%s", tc.providerUrl, tc.clientId) |
| 57 | +} |
| 58 | + |
| 59 | +func (tc *tokenCache) getCachedRefreshToken() (string, error) { |
| 60 | + if tc == nil || tc.ring == nil { |
| 61 | + return "", errCacheNotInitialized |
| 62 | + } |
| 63 | + |
| 64 | + key := tc.getKey() |
| 65 | + item, err := tc.ring.Get(key) |
| 66 | + if err != nil { |
| 67 | + if errors.Is(err, keyring.ErrKeyNotFound) { |
| 68 | + return "", nil |
| 69 | + } |
| 70 | + return "", fmt.Errorf("failed to get token from keyring: %w", err) |
| 71 | + } |
| 72 | + |
| 73 | + var cached cachedToken |
| 74 | + if err := json.Unmarshal(item.Data, &cached); err != nil { |
| 75 | + return "", fmt.Errorf("failed to unmarshal cached token: %w", err) |
| 76 | + } |
| 77 | + |
| 78 | + return cached.RefreshToken, nil |
| 79 | +} |
| 80 | + |
| 81 | +func (tc *tokenCache) saveRefreshToken(refreshToken string) error { |
| 82 | + if tc == nil || tc.ring == nil { |
| 83 | + return errCacheNotInitialized |
| 84 | + } |
| 85 | + |
| 86 | + if refreshToken == "" { |
| 87 | + return errors.New("refresh token is empty") |
| 88 | + } |
| 89 | + |
| 90 | + key := tc.getKey() |
| 91 | + cached := cachedToken{ |
| 92 | + RefreshToken: refreshToken, |
| 93 | + } |
| 94 | + |
| 95 | + data, err := json.Marshal(cached) |
| 96 | + if err != nil { |
| 97 | + return fmt.Errorf("failed to marshal token: %w", err) |
| 98 | + } |
| 99 | + |
| 100 | + item := keyring.Item{ |
| 101 | + Key: key, |
| 102 | + Data: data, |
| 103 | + Label: fmt.Sprintf("Armada OIDC Refresh Token (%s)", tc.clientId), |
| 104 | + Description: fmt.Sprintf("OAuth2 refresh token for %s", tc.providerUrl), |
| 105 | + } |
| 106 | + |
| 107 | + if err := tc.ring.Set(item); err != nil { |
| 108 | + return fmt.Errorf("failed to save refresh token to keyring: %w", err) |
| 109 | + } |
| 110 | + |
| 111 | + return nil |
| 112 | +} |
| 113 | + |
| 114 | +func (tc *tokenCache) deleteToken() error { |
| 115 | + if tc == nil || tc.ring == nil { |
| 116 | + return errCacheNotInitialized |
| 117 | + } |
| 118 | + |
| 119 | + if err := tc.ring.Remove(tc.getKey()); err != nil && !errors.Is(err, keyring.ErrKeyNotFound) { |
| 120 | + return fmt.Errorf("failed to delete token from keyring: %w", err) |
| 121 | + } |
| 122 | + return nil |
| 123 | +} |
| 124 | + |
| 125 | +// refreshToken exchanges a refresh token for a new access token. |
| 126 | +// If the provider returns a new refresh token (rotation), it updates the cache. |
| 127 | +func refreshToken(ctx context.Context, config *oauth2.Config, refreshToken string, cache *tokenCache) (*oauth2.Token, error) { |
| 128 | + if refreshToken == "" { |
| 129 | + return nil, errors.New("no refresh token available") |
| 130 | + } |
| 131 | + |
| 132 | + oldToken := &oauth2.Token{ |
| 133 | + RefreshToken: refreshToken, |
| 134 | + TokenType: "Bearer", |
| 135 | + Expiry: time.Now().Add(-1 * time.Hour), |
| 136 | + } |
| 137 | + |
| 138 | + tokenSource := config.TokenSource(ctx, oldToken) |
| 139 | + |
| 140 | + newToken, err := tokenSource.Token() |
| 141 | + if err != nil { |
| 142 | + return nil, fmt.Errorf("failed to refresh token: %w", err) |
| 143 | + } |
| 144 | + |
| 145 | + if newToken.RefreshToken != "" { |
| 146 | + if cache != nil { |
| 147 | + if saveErr := cache.saveRefreshToken(newToken.RefreshToken); saveErr != nil { |
| 148 | + log.WithError(saveErr).Error("Failed to save refreshed token to cache") |
| 149 | + } |
| 150 | + } |
| 151 | + } else { |
| 152 | + newToken.RefreshToken = refreshToken |
| 153 | + } |
| 154 | + |
| 155 | + return newToken, nil |
| 156 | +} |
| 157 | + |
| 158 | +// tryGetCachedToken attempts to retrieve and refresh a cached token. |
| 159 | +// Returns (nil, cache) if no valid cached token exists but caching is available. |
| 160 | +func tryGetCachedToken( |
| 161 | + ctx context.Context, |
| 162 | + config *oauth2.Config, |
| 163 | + providerUrl string, |
| 164 | + clientId string, |
| 165 | + cacheEnabled bool, |
| 166 | +) (*oauth2.Token, *tokenCache) { |
| 167 | + if !cacheEnabled { |
| 168 | + return nil, nil |
| 169 | + } |
| 170 | + |
| 171 | + cache, err := newTokenCache(providerUrl, clientId) |
| 172 | + if err != nil { |
| 173 | + log.Warn("Token cache unavailable, proceeding without caching") |
| 174 | + return nil, nil |
| 175 | + } |
| 176 | + |
| 177 | + cachedRefreshToken, err := cache.getCachedRefreshToken() |
| 178 | + if err != nil || cachedRefreshToken == "" { |
| 179 | + return nil, cache |
| 180 | + } |
| 181 | + |
| 182 | + newToken, err := refreshToken(ctx, config, cachedRefreshToken, cache) |
| 183 | + if err != nil { |
| 184 | + _ = cache.deleteToken() |
| 185 | + return nil, cache |
| 186 | + } |
| 187 | + |
| 188 | + return newToken, cache |
| 189 | +} |
| 190 | + |
| 191 | +func saveTokenToCache(token *oauth2.Token, cache *tokenCache) { |
| 192 | + if cache == nil || token == nil || token.RefreshToken == "" { |
| 193 | + return |
| 194 | + } |
| 195 | + |
| 196 | + if err := cache.saveRefreshToken(token.RefreshToken); err != nil { |
| 197 | + log.WithError(err).Error("Failed to save token to cache") |
| 198 | + } |
| 199 | +} |
0 commit comments