-
Notifications
You must be signed in to change notification settings - Fork 2
/
Config.cs
473 lines (410 loc) · 15.7 KB
/
Config.cs
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
using System;
using System.Linq;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Net.Http;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json; // System.Text.Json was not deserializing properly
using System.Collections.Concurrent;
using Azure.Identity;
using Azure.Core;
namespace NetBricks;
public class Config : IConfig, IDisposable
{
private readonly DefaultAzureCredential defaultAzureCredential;
private HttpClient httpClient;
private readonly ConcurrentDictionary<string, object> cache = new();
private readonly IConfigProvider configProvider;
private bool disposed = false;
public Config(IConfigProvider configProvider = null)
{
this.configProvider = configProvider ?? new EnvVarChainConfigProvider();
// get the list of credential options
string[] include = (INCLUDE_CREDENTIAL_TYPES.Length > 0)
? INCLUDE_CREDENTIAL_TYPES :
string.Equals(ASPNETCORE_ENVIRONMENT, "Development", StringComparison.InvariantCultureIgnoreCase)
? ["azcli", "env"]
: ["env", "mi"];
// log
Console.WriteLine($"INCLUDE_CREDENTIAL_TYPES = \"{string.Join(", ", include)}\"");
// build the credential object
this.defaultAzureCredential = new DefaultAzureCredential(
new DefaultAzureCredentialOptions()
{
ExcludeEnvironmentCredential = !include.Contains("env"),
ExcludeManagedIdentityCredential = !include.Contains("mi"),
ExcludeSharedTokenCacheCredential = !include.Contains("token"),
ExcludeVisualStudioCredential = !include.Contains("vs"),
ExcludeVisualStudioCodeCredential = !include.Contains("vscode"),
ExcludeAzureCliCredential = !include.Contains("azcli"),
ExcludeInteractiveBrowserCredential = !include.Contains("browser"),
});
}
public DefaultAzureCredential DefaultAzureCredential => this.defaultAzureCredential;
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{
if (!disposed)
{
if (disposing)
{
// Dispose managed resources.
this.httpClient?.Dispose();
}
// Dispose unmanaged resources.
disposed = true;
}
}
~Config()
{
Dispose(false);
}
private class AppConfigItems
{
public AppConfigItem[] items = null;
}
private class AppConfigItem
{
public string content_type = null;
public string key = null;
public string value = null;
}
private class KeyVaultRef
{
public string uri = null;
}
public async Task<Dictionary<string, string>> Load(string[] filters, bool useFullyQualifiedName = false)
{
// exit if there is nothing requested or no way to get it
Dictionary<string, string> kv = [];
if (string.IsNullOrEmpty(APPCONFIG_URL)) return kv;
if (filters == null || filters.Length < 1) return kv;
// get an access token
var tokenRequestContext = new TokenRequestContext([$"{APPCONFIG_URL}/.default"]);
var tokenResponse = await this.defaultAzureCredential.GetTokenAsync(tokenRequestContext);
var accessToken = tokenResponse.Token;
// process each key filter request
foreach (var filter in filters)
{
// make authenticated calls to Azure AppConfig
using var request = new HttpRequestMessage()
{
RequestUri = new Uri($"{APPCONFIG_URL}/kv?key={filter}"),
Method = HttpMethod.Get
};
request.Headers.Add("Authorization", $"Bearer {accessToken}");
this.httpClient ??= new HttpClient();
using (var response = await this.httpClient.SendAsync(request))
{
// evaluate the response
var raw = await response.Content.ReadAsStringAsync();
if ((int)response.StatusCode == 401 || (int)response.StatusCode == 403)
{
throw new Exception($"Load: The identity is not authorized to get key/value pairs from the AppConfig \"{APPCONFIG_URL}\"; make sure this is the right instance and that you have granted rights to the Managed Identity or Service Principal. If running locally, make sure you have run an \"az login\" with the correct account and subscription.");
}
else if (!response.IsSuccessStatusCode)
{
throw new Exception($"Load: HTTP {(int)response.StatusCode} - {raw}");
}
// look for key/value pairs
var json = JsonConvert.DeserializeObject<AppConfigItems>(raw);
foreach (var item in json.items)
{
var key = useFullyQualifiedName ? item.key : item.key.Split(":").Last();
key = key.ToUpper();
var val = item.value;
if (item.content_type != null && item.content_type.Contains("vnd.microsoft.appconfig.keyvaultref", StringComparison.InvariantCultureIgnoreCase))
{
val = JsonConvert.DeserializeObject<KeyVaultRef>(item.value).uri;
}
kv.TryAdd(key, val);
}
};
}
return kv;
}
public async Task Apply(string[] filters = null)
{
// show configuration
if (!string.IsNullOrEmpty(APPCONFIG_URL))
Console.WriteLine($"APPCONFIG_URL = \"{APPCONFIG_URL}\"");
if (CONFIG_KEYS is not null && CONFIG_KEYS.Length > 0)
Console.WriteLine($"CONFIG_KEYS = \"{string.Join(", ", CONFIG_KEYS)}\"");
// load the config
filters ??= CONFIG_KEYS;
Dictionary<string, string> kv = await Load(filters);
// apply the config
foreach (var pair in kv)
{
Environment.SetEnvironmentVariable(pair.Key, pair.Value);
}
// log
Console.WriteLine($"LOADED KEYS: {string.Join(", ", kv.Keys)}");
}
private class KeyVaultItem
{
public string value = null;
}
public async Task<string> GetFromKeyVault(string posurl, bool ignore404 = false)
{
if (!string.IsNullOrEmpty(posurl) &&
posurl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase) &&
posurl.Contains(".vault.azure.net/", StringComparison.InvariantCultureIgnoreCase))
{
// get an access token
var tokenRequestContext = new TokenRequestContext([$"https://vault.azure.net/.default"]);
var tokenResponse = await this.defaultAzureCredential.GetTokenAsync(tokenRequestContext);
var accessToken = tokenResponse.Token;
// get from the keyvault
using (var request = new HttpRequestMessage()
{
RequestUri = new Uri($"{posurl}?api-version=7.0"),
Method = HttpMethod.Get
})
{
request.Headers.Add("Authorization", $"Bearer {accessToken}");
this.httpClient ??= new HttpClient();
using var response = await this.httpClient.SendAsync(request);
var raw = await response.Content.ReadAsStringAsync();
if (ignore404 && (int)response.StatusCode == 404) // Not Found
{
return string.Empty;
}
else if (!response.IsSuccessStatusCode)
{
throw new Exception($"Config.GetFromKeyVault: HTTP {(int)response.StatusCode} - {raw}");
}
var item = JsonConvert.DeserializeObject<KeyVaultItem>(raw);
return item.value;
};
}
else
{
return posurl;
}
}
public static string GetOnce(params string[] keys)
{
foreach (string key in keys)
{
string val = System.Environment.GetEnvironmentVariable(key);
if (!string.IsNullOrEmpty(val)) return val;
}
return null;
}
public async Task<T> GetSecret<T>(string key, Func<string, T> convert = null, bool ignore404 = false)
{
// ensure this is string or has a convert method
if (typeof(T) != typeof(string) && convert == null)
{
throw new Exception("Get<T>() cannot be used without convert except when the datatype is string.");
}
// get from cache
if (GetFromCache<T>(key, out T val)) return val;
// get from environment variable
var str = this.configProvider.Get(key);
// get from key vault
str = await GetFromKeyVault(str, ignore404);
// IMPORTANT: all Get methods should ensure empty strings are returned as null to support ??
// EXCEPTION: it is possible that the convert() might do something different
if (string.IsNullOrEmpty(str)) str = null;
// convert
if (convert != null)
{
val = convert(str);
}
else
{
val = (T)(object)str;
}
// add to cache
AddToCache<T>(key, val);
return val;
}
public T Get<T>(string key, Func<string, T> convert = null)
{
// ensure this is string or has a convert method
if (typeof(T) != typeof(string) && convert == null)
{
throw new ArgumentNullException("Get<T>() cannot be used without convert except when the datatype is string.");
}
// get from cache
if (GetFromCache<T>(key, out T val)) return val;
// get from environment variable
var str = this.configProvider.Get(key);
// IMPORTANT: all Get methods should ensure empty strings are returned as null to support ??
// EXCEPTION: it is possible that the convert() might do something different
if (string.IsNullOrEmpty(str)) str = null;
// convert
if (convert != null)
{
val = convert(str);
}
else
{
val = (T)(object)str;
}
// add to cache
AddToCache<T>(key, val);
return val;
}
public bool GetFromCache<T>(string key, out T val)
{
if (this.cache.TryGetValue(key, out object obj))
{
val = (T)obj;
return true;
}
else
{
val = default;
return false;
}
}
public void AddToCache<T>(string key, T val)
{
this.cache.TryAdd(key, val);
}
public void RemoveFromCache(string key)
{
this.cache.TryRemove(key, out object _);
}
private string HideIfAppropriate(string value, bool hideValue)
{
if (!hideValue) return value;
if (value.StartsWith("https://") && value.Contains(".vault.azure.net/", StringComparison.InvariantCultureIgnoreCase)) return value;
return "(set)";
}
public void Require(string key, string value, bool hideValue = false)
{
if (string.IsNullOrEmpty(value))
{
Console.WriteLine($"{key} is REQUIRED but missing.");
throw new Exception($"{key} is REQUIRED but missing.");
}
else
{
string val = HideIfAppropriate(value, hideValue);
Console.WriteLine($"{key} = \"{val}\"");
}
}
public void Require(string key, string[] values, bool hideValue = false)
{
if (!values.Any(v => v.Trim().Length > 0))
{
Console.WriteLine($"{key} is REQUIRED but missing.");
throw new Exception($"{key} is REQUIRED but missing.");
}
else
{
string val = HideIfAppropriate(string.Join(", ", values), hideValue);
Console.WriteLine($"{key} = \"{val}\"");
}
}
public void Require(string key, bool value, bool hideValue = false)
{
Require(key, value.ToString(), hideValue);
}
public void Require(string key, int value, bool hideValue = false)
{
Require(key, value.ToString(), hideValue);
}
public void Require(string key, bool hideValue = false)
{
string value = this.configProvider.Get(key);
Require(key, value, hideValue);
}
public bool Optional(string key, string value, bool hideValue = false, bool hideIfEmpty = false)
{
if (string.IsNullOrEmpty(value))
{
if (!hideIfEmpty) Console.WriteLine($"{key} is \"(not-set)\".");
return false;
}
else
{
string val = HideIfAppropriate(value, hideValue);
Console.WriteLine($"{key} = \"{val}\"");
return true;
}
}
public bool Optional(string key, string[] values, bool hideValue = false, bool hideIfEmpty = false)
{
if (values == null || values.Count(v => !string.IsNullOrWhiteSpace(v)) < 1)
{
if (!hideIfEmpty) Console.WriteLine($"{key} is \"(not-set)\".");
return false;
}
else
{
string val = HideIfAppropriate(string.Join(", ", values), hideValue);
Console.WriteLine($"{key} = \"{val}\"");
return true;
}
}
public bool Optional(string key, bool value, bool hideValue = false, bool hideIfEmpty = false)
{
string val = HideIfAppropriate(value.ToString(), hideValue);
Console.WriteLine($"{key} = \"{val}\"");
return true;
}
public bool Optional(string key, int value, bool hideValue = false, bool hideIfEmpty = false)
{
string val = HideIfAppropriate(value.ToString(), hideValue);
Console.WriteLine($"{key} = \"{val}\"");
return true;
}
public bool Optional(string key, bool hideValue = false, bool hideIfEmpty = false)
{
string value = this.configProvider.Get(key);
if (string.IsNullOrEmpty(value))
{
if (!hideIfEmpty) Console.WriteLine($"{key} is \"(not-set)\".");
return false;
}
else
{
string val = HideIfAppropriate(value, hideValue);
Console.WriteLine($"{key} = \"{val}\"");
return true;
}
}
public static LogLevel LOG_LEVEL
{
get => GetOnce("LOG_LEVEL").AsEnum<LogLevel>(() => LogLevel.Information);
}
public static bool DISABLE_COLORS
{
get => GetOnce("DISABLE_COLORS").AsBool(() => false);
}
public static string APPCONFIG_URL
{
get
{
var val = GetOnce("APPCONFIG", "APPCONFIG_URL");
if (!string.IsNullOrEmpty(val))
{
val = val.ToLower();
if (!val.Contains(".azconfig.io")) val += ".azconfig.io";
if (!val.StartsWith("https://")) val = "https://" + val;
}
return val;
}
}
public static string[] CONFIG_KEYS
{
get => GetOnce("CONFIG_KEYS").AsArray(() => null);
}
public static string ASPNETCORE_ENVIRONMENT
{
get => GetOnce("ASPNETCORE_ENVIRONMENT").AsString(() => "Development");
}
public static string[] INCLUDE_CREDENTIAL_TYPES
{
get => GetOnce("INCLUDE_CREDENTIAL_TYPES").AsArray(() => []);
}
}