|
| 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 | +type TokenCache struct { |
| 21 | + ring keyring.Keyring |
| 22 | + providerUrl string |
| 23 | + clientId string |
| 24 | +} |
| 25 | + |
| 26 | +type CachedToken struct { |
| 27 | + RefreshToken string `json:"refresh_token"` |
| 28 | + TokenType string `json:"token_type"` |
| 29 | + StoredAt time.Time `json:"stored_at"` |
| 30 | + RefreshExpiry *time.Time `json:"refresh_expiry,omitempty"` |
| 31 | +} |
| 32 | + |
| 33 | +func NewTokenCache(providerUrl, clientId string) (*TokenCache, error) { |
| 34 | + ring, err := keyring.Open(keyring.Config{ |
| 35 | + ServiceName: keyringServiceName, |
| 36 | + AllowedBackends: keyring.AvailableBackends(), |
| 37 | + KeychainTrustApplication: true, |
| 38 | + KeychainSynchronizable: false, |
| 39 | + KeychainAccessibleWhenUnlocked: true, |
| 40 | + KWalletAppID: "armada", |
| 41 | + KWalletFolder: "armada", |
| 42 | + LibSecretCollectionName: "armada", |
| 43 | + WinCredPrefix: "armada", |
| 44 | + }) |
| 45 | + if err != nil { |
| 46 | + log.Debug("No secure keyring backend available, token caching disabled") |
| 47 | + return nil, fmt.Errorf("no secure keyring backend available: %w", err) |
| 48 | + } |
| 49 | + |
| 50 | + return &TokenCache{ |
| 51 | + ring: ring, |
| 52 | + providerUrl: providerUrl, |
| 53 | + clientId: clientId, |
| 54 | + }, nil |
| 55 | +} |
| 56 | + |
| 57 | +func (tc *TokenCache) getKey() string { |
| 58 | + return fmt.Sprintf("%s:%s", tc.providerUrl, tc.clientId) |
| 59 | +} |
| 60 | + |
| 61 | +func (tc *TokenCache) GetCachedRefreshToken() (string, error) { |
| 62 | + if tc == nil || tc.ring == nil { |
| 63 | + return "", errors.New("token cache not initialized") |
| 64 | + } |
| 65 | + |
| 66 | + key := tc.getKey() |
| 67 | + item, err := tc.ring.Get(key) |
| 68 | + if err != nil { |
| 69 | + if errors.Is(err, keyring.ErrKeyNotFound) { |
| 70 | + return "", nil // No cached token |
| 71 | + } |
| 72 | + return "", fmt.Errorf("failed to get token from keyring: %w", err) |
| 73 | + } |
| 74 | + |
| 75 | + var cached CachedToken |
| 76 | + if err := json.Unmarshal(item.Data, &cached); err != nil { |
| 77 | + return "", fmt.Errorf("failed to unmarshal cached token: %w", err) |
| 78 | + } |
| 79 | + |
| 80 | + if cached.RefreshExpiry != nil && time.Now().After(*cached.RefreshExpiry) { |
| 81 | + _ = tc.DeleteToken() |
| 82 | + return "", nil |
| 83 | + } |
| 84 | + |
| 85 | + return cached.RefreshToken, nil |
| 86 | +} |
| 87 | + |
| 88 | +func (tc *TokenCache) SaveRefreshToken(refreshToken string) error { |
| 89 | + if tc == nil || tc.ring == nil { |
| 90 | + return errors.New("token cache not initialized") |
| 91 | + } |
| 92 | + |
| 93 | + if refreshToken == "" { |
| 94 | + return errors.New("refresh token is empty") |
| 95 | + } |
| 96 | + |
| 97 | + key := tc.getKey() |
| 98 | + cached := CachedToken{ |
| 99 | + RefreshToken: refreshToken, |
| 100 | + TokenType: "Bearer", |
| 101 | + StoredAt: time.Now(), |
| 102 | + } |
| 103 | + |
| 104 | + data, err := json.Marshal(cached) |
| 105 | + if err != nil { |
| 106 | + return fmt.Errorf("failed to marshal token: %w", err) |
| 107 | + } |
| 108 | + |
| 109 | + item := keyring.Item{ |
| 110 | + Key: key, |
| 111 | + Data: data, |
| 112 | + Label: fmt.Sprintf("Armada OIDC Refresh Token (%s)", tc.clientId), |
| 113 | + Description: fmt.Sprintf("OAuth2 refresh token for %s", tc.providerUrl), |
| 114 | + } |
| 115 | + |
| 116 | + if err := tc.ring.Set(item); err != nil { |
| 117 | + return fmt.Errorf("failed to save refresh token to keyring: %w", err) |
| 118 | + } |
| 119 | + |
| 120 | + return nil |
| 121 | +} |
| 122 | + |
| 123 | +func (tc *TokenCache) DeleteToken() error { |
| 124 | + if tc == nil || tc.ring == nil { |
| 125 | + return errors.New("token cache not initialized") |
| 126 | + } |
| 127 | + |
| 128 | + if err := tc.ring.Remove(tc.getKey()); err != nil && !errors.Is(err, keyring.ErrKeyNotFound) { |
| 129 | + return fmt.Errorf("failed to delete token from keyring: %w", err) |
| 130 | + } |
| 131 | + return nil |
| 132 | +} |
| 133 | + |
| 134 | +func RefreshTokenSecurely(ctx context.Context, config *oauth2.Config, refreshToken string, cache *TokenCache) (*oauth2.Token, error) { |
| 135 | + if refreshToken == "" { |
| 136 | + return nil, errors.New("no refresh token available") |
| 137 | + } |
| 138 | + |
| 139 | + oldToken := &oauth2.Token{ |
| 140 | + RefreshToken: refreshToken, |
| 141 | + TokenType: "Bearer", |
| 142 | + Expiry: time.Now().Add(-1 * time.Hour), |
| 143 | + } |
| 144 | + |
| 145 | + tokenSource := config.TokenSource(ctx, oldToken) |
| 146 | + |
| 147 | + newToken, err := tokenSource.Token() |
| 148 | + if err != nil { |
| 149 | + return nil, fmt.Errorf("failed to refresh token: %w", err) |
| 150 | + } |
| 151 | + |
| 152 | + if newToken.RefreshToken != "" { |
| 153 | + if cache != nil { |
| 154 | + if saveErr := cache.SaveRefreshToken(newToken.RefreshToken); saveErr != nil { |
| 155 | + log.WithError(saveErr).Error("Failed to save refreshed token to cache") |
| 156 | + } |
| 157 | + } |
| 158 | + } else { |
| 159 | + newToken.RefreshToken = refreshToken |
| 160 | + } |
| 161 | + |
| 162 | + return newToken, nil |
| 163 | +} |
| 164 | + |
| 165 | +func TryGetCachedToken( |
| 166 | + ctx context.Context, |
| 167 | + config *oauth2.Config, |
| 168 | + providerUrl string, |
| 169 | + clientId string, |
| 170 | + cacheEnabled bool, |
| 171 | +) (*oauth2.Token, *TokenCache, error) { |
| 172 | + if !cacheEnabled { |
| 173 | + return nil, nil, nil |
| 174 | + } |
| 175 | + |
| 176 | + cache, err := NewTokenCache(providerUrl, clientId) |
| 177 | + if err != nil { |
| 178 | + log.Debug("Token cache unavailable, proceeding without caching") |
| 179 | + return nil, nil, nil |
| 180 | + } |
| 181 | + |
| 182 | + cachedRefreshToken, err := cache.GetCachedRefreshToken() |
| 183 | + if err != nil || cachedRefreshToken == "" { |
| 184 | + return nil, cache, nil |
| 185 | + } |
| 186 | + |
| 187 | + newToken, err := RefreshTokenSecurely(ctx, config, cachedRefreshToken, cache) |
| 188 | + if err != nil { |
| 189 | + _ = cache.DeleteToken() |
| 190 | + return nil, cache, nil |
| 191 | + } |
| 192 | + |
| 193 | + return newToken, cache, nil |
| 194 | +} |
| 195 | + |
| 196 | +func SaveTokenToCache(token *oauth2.Token, cache *TokenCache) { |
| 197 | + if cache == nil || token == nil || token.RefreshToken == "" { |
| 198 | + return |
| 199 | + } |
| 200 | + |
| 201 | + if err := cache.SaveRefreshToken(token.RefreshToken); err != nil { |
| 202 | + log.WithError(err).Debug("Failed to save token to cache") |
| 203 | + } |
| 204 | +} |
0 commit comments