|
| 1 | +package helpers |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "os" |
| 6 | + "path/filepath" |
| 7 | + |
| 8 | + "github.com/zalando/go-keyring" |
| 9 | + "gopkg.in/yaml.v3" |
| 10 | +) |
| 11 | + |
| 12 | +const ( |
| 13 | + serviceName = "stacktodate" |
| 14 | + username = "token" |
| 15 | +) |
| 16 | + |
| 17 | +// CredentialSource indicates where a credential came from |
| 18 | +type CredentialSource string |
| 19 | + |
| 20 | +const ( |
| 21 | + SourceEnvVar CredentialSource = "environment variable" |
| 22 | + SourceKeyring CredentialSource = "OS keychain" |
| 23 | + SourceFile CredentialSource = "config file" |
| 24 | +) |
| 25 | + |
| 26 | +// CredentialInfo contains information about stored credentials |
| 27 | +type CredentialInfo struct { |
| 28 | + Token string |
| 29 | + Source CredentialSource |
| 30 | +} |
| 31 | + |
| 32 | +// credentialsFile represents the structure of the credentials YAML file |
| 33 | +type credentialsFile struct { |
| 34 | + Token string `yaml:"token"` |
| 35 | +} |
| 36 | + |
| 37 | +// GetToken retrieves the API token using the priority order: |
| 38 | +// 1. STD_TOKEN environment variable (highest priority) |
| 39 | +// 2. OS Keychain (macOS/Linux/Windows) |
| 40 | +// 3. Returns error if not found (Option B - fail securely) |
| 41 | +func GetToken() (string, error) { |
| 42 | + // Check environment variable first |
| 43 | + if token := os.Getenv("STD_TOKEN"); token != "" { |
| 44 | + return token, nil |
| 45 | + } |
| 46 | + |
| 47 | + // Try to get from keychain |
| 48 | + token, err := keyring.Get(serviceName, username) |
| 49 | + if err == nil && token != "" { |
| 50 | + return token, nil |
| 51 | + } |
| 52 | + |
| 53 | + // Try to get from fallback file (for migration purposes, but don't use it by default) |
| 54 | + if token, err := getTokenFromFile(); err == nil && token != "" { |
| 55 | + return token, nil |
| 56 | + } |
| 57 | + |
| 58 | + // No token found anywhere |
| 59 | + return "", fmt.Errorf("no authentication token found\n\nSetup your token with one of these methods:\n 1. Interactive setup: stacktodate global-config set\n 2. Environment variable: export STD_TOKEN=<your_token>\n\nFor more help: stacktodate global-config --help") |
| 60 | +} |
| 61 | + |
| 62 | +// GetTokenWithSource retrieves the token and returns information about its source |
| 63 | +func GetTokenWithSource() (*CredentialInfo, error) { |
| 64 | + // Check environment variable first |
| 65 | + if token := os.Getenv("STD_TOKEN"); token != "" { |
| 66 | + return &CredentialInfo{ |
| 67 | + Token: token, |
| 68 | + Source: SourceEnvVar, |
| 69 | + }, nil |
| 70 | + } |
| 71 | + |
| 72 | + // Try to get from keychain |
| 73 | + token, err := keyring.Get(serviceName, username) |
| 74 | + if err == nil && token != "" { |
| 75 | + return &CredentialInfo{ |
| 76 | + Token: token, |
| 77 | + Source: SourceKeyring, |
| 78 | + }, nil |
| 79 | + } |
| 80 | + |
| 81 | + // Try to get from fallback file |
| 82 | + if token, err := getTokenFromFile(); err == nil && token != "" { |
| 83 | + return &CredentialInfo{ |
| 84 | + Token: token, |
| 85 | + Source: SourceFile, |
| 86 | + }, nil |
| 87 | + } |
| 88 | + |
| 89 | + // No token found anywhere |
| 90 | + return nil, fmt.Errorf("no authentication token found") |
| 91 | +} |
| 92 | + |
| 93 | +// SetToken stores the token in the OS keychain |
| 94 | +// Falls back to file storage if keychain is unavailable |
| 95 | +// Per Option B: Fails if keychain is unavailable and no fallback |
| 96 | +func SetToken(token string) error { |
| 97 | + // Ensure config directory exists |
| 98 | + if err := EnsureConfigDir(); err != nil { |
| 99 | + return fmt.Errorf("failed to create config directory: %w", err) |
| 100 | + } |
| 101 | + |
| 102 | + // Try to store in keychain first |
| 103 | + err := keyring.Set(serviceName, username, token) |
| 104 | + if err == nil { |
| 105 | + return nil |
| 106 | + } |
| 107 | + |
| 108 | + // If keychain fails, also try file storage as a fallback |
| 109 | + // This allows local development to work |
| 110 | + if err := setTokenInFile(token); err != nil { |
| 111 | + return fmt.Errorf("failed to store token securely:\n Keychain error: %v\n File storage error: %v\n\nFor CI/headless environments, use: export STD_TOKEN=<your_token>", err, err) |
| 112 | + } |
| 113 | + |
| 114 | + fmt.Println("⚠️ Warning: Token stored in plain text file at ~/.stacktodate/credentials.yaml") |
| 115 | + fmt.Println("For better security, consider using a system with OS keychain support") |
| 116 | + return nil |
| 117 | +} |
| 118 | + |
| 119 | +// DeleteToken removes the token from keychain and file storage |
| 120 | +func DeleteToken() error { |
| 121 | + var keychainErr error |
| 122 | + var fileErr error |
| 123 | + |
| 124 | + // Try to delete from keychain |
| 125 | + keychainErr = keyring.Delete(serviceName, username) |
| 126 | + |
| 127 | + // Try to delete from file |
| 128 | + fileErr = deleteTokenFromFile() |
| 129 | + |
| 130 | + // If both failed, return error |
| 131 | + if keychainErr != nil && fileErr != nil { |
| 132 | + return fmt.Errorf("failed to delete token: keychain error: %v, file error: %v", keychainErr, fileErr) |
| 133 | + } |
| 134 | + |
| 135 | + return nil |
| 136 | +} |
| 137 | + |
| 138 | +// GetTokenSource returns information about where the token is currently stored |
| 139 | +func GetTokenSource() (string, bool, error) { |
| 140 | + // Check environment variable |
| 141 | + if os.Getenv("STD_TOKEN") != "" { |
| 142 | + return "STD_TOKEN environment variable", true, nil |
| 143 | + } |
| 144 | + |
| 145 | + // Check keychain |
| 146 | + _, err := keyring.Get(serviceName, username) |
| 147 | + if err == nil { |
| 148 | + return "OS keychain", true, nil |
| 149 | + } |
| 150 | + |
| 151 | + // Check file |
| 152 | + if _, err := getTokenFromFile(); err == nil { |
| 153 | + return "credentials file (~/.stacktodate/credentials.yaml)", false, nil |
| 154 | + } |
| 155 | + |
| 156 | + return "not configured", false, fmt.Errorf("no token found") |
| 157 | +} |
| 158 | + |
| 159 | +// EnsureConfigDir creates the ~/.stacktodate directory if it doesn't exist |
| 160 | +func EnsureConfigDir() error { |
| 161 | + configDir := getConfigDir() |
| 162 | + return os.MkdirAll(configDir, 0700) |
| 163 | +} |
| 164 | + |
| 165 | +// Helper functions |
| 166 | + |
| 167 | +func getConfigDir() string { |
| 168 | + home, err := os.UserHomeDir() |
| 169 | + if err != nil { |
| 170 | + // Fallback to current directory if home can't be determined |
| 171 | + return ".stacktodate" |
| 172 | + } |
| 173 | + return filepath.Join(home, ".stacktodate") |
| 174 | +} |
| 175 | + |
| 176 | +func getCredentialsFilePath() string { |
| 177 | + return filepath.Join(getConfigDir(), "credentials.yaml") |
| 178 | +} |
| 179 | + |
| 180 | +func getTokenFromFile() (string, error) { |
| 181 | + filePath := getCredentialsFilePath() |
| 182 | + |
| 183 | + content, err := os.ReadFile(filePath) |
| 184 | + if err != nil { |
| 185 | + return "", fmt.Errorf("failed to read credentials file: %w", err) |
| 186 | + } |
| 187 | + |
| 188 | + var creds credentialsFile |
| 189 | + if err := yaml.Unmarshal(content, &creds); err != nil { |
| 190 | + return "", fmt.Errorf("failed to parse credentials file: %w", err) |
| 191 | + } |
| 192 | + |
| 193 | + return creds.Token, nil |
| 194 | +} |
| 195 | + |
| 196 | +func setTokenInFile(token string) error { |
| 197 | + filePath := getCredentialsFilePath() |
| 198 | + |
| 199 | + creds := credentialsFile{ |
| 200 | + Token: token, |
| 201 | + } |
| 202 | + |
| 203 | + content, err := yaml.Marshal(creds) |
| 204 | + if err != nil { |
| 205 | + return fmt.Errorf("failed to marshal credentials: %w", err) |
| 206 | + } |
| 207 | + |
| 208 | + // Write with restricted permissions (0600 = read/write for owner only) |
| 209 | + if err := os.WriteFile(filePath, content, 0600); err != nil { |
| 210 | + return fmt.Errorf("failed to write credentials file: %w", err) |
| 211 | + } |
| 212 | + |
| 213 | + return nil |
| 214 | +} |
| 215 | + |
| 216 | +func deleteTokenFromFile() error { |
| 217 | + filePath := getCredentialsFilePath() |
| 218 | + if err := os.Remove(filePath); err != nil && !os.IsNotExist(err) { |
| 219 | + return fmt.Errorf("failed to delete credentials file: %w", err) |
| 220 | + } |
| 221 | + return nil |
| 222 | +} |
0 commit comments