using System; #if NETSTANDARD2_0 using Newtonsoft.Json; using System.Collections.Generic; using System.Diagnostics; #endif using System.IO; using System.Linq; using System.Runtime.InteropServices; using System.Security.Cryptography.X509Certificates; using System.Threading.Tasks; using k8s.Exceptions; using k8s.KubeConfigModels; namespace k8s { public partial class KubernetesClientConfiguration { /// /// kubeconfig Default Location /// private static readonly string KubeConfigDefaultLocation = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? Path.Combine(Environment.GetEnvironmentVariable("USERPROFILE"), @".kube\config") : Path.Combine(Environment.GetEnvironmentVariable("HOME"), ".kube/config"); /// /// Gets CurrentContext /// public string CurrentContext { get; private set; } /// /// Initializes a new instance of the from default locations /// If the KUBECONFIG environment variable is set, then that will be used. /// Next, it looks for a config file at . /// Then, it checks whether it is executing inside a cluster and will use . /// Finally, if nothing else exists, it creates a default config with localhost:8080 as host. /// public static KubernetesClientConfiguration BuildDefaultConfig() { var kubeconfig = Environment.GetEnvironmentVariable("KUBECONFIG"); if (kubeconfig != null) { return BuildConfigFromConfigFile(kubeconfigPath: kubeconfig); } if (File.Exists(KubeConfigDefaultLocation)) { return BuildConfigFromConfigFile(kubeconfigPath: KubeConfigDefaultLocation); } if (IsInCluster()) { return InClusterConfig(); } var config = new KubernetesClientConfiguration(); config.Host = "http://localhost:8080"; return config; } /// /// Initializes a new instance of the from config file /// /// Explicit file path to kubeconfig. Set to null to use the default file path /// override the context in config file, set null if do not want to override /// kube api server endpoint /// When , the paths in the kubeconfig file will be considered to be relative to the directory in which the kubeconfig /// file is located. When , the paths will be considered to be relative to the current working directory. public static KubernetesClientConfiguration BuildConfigFromConfigFile(string kubeconfigPath = null, string currentContext = null, string masterUrl = null, bool useRelativePaths = true) { return BuildConfigFromConfigFile(new FileInfo(kubeconfigPath ?? KubeConfigDefaultLocation), currentContext, masterUrl, useRelativePaths); } /// /// Initializes a new instance of the from config file /// /// Fileinfo of the kubeconfig, cannot be null /// override the context in config file, set null if do not want to override /// override the kube api server endpoint, set null if do not want to override /// When , the paths in the kubeconfig file will be considered to be relative to the directory in which the kubeconfig /// file is located. When , the paths will be considered to be relative to the current working directory. public static KubernetesClientConfiguration BuildConfigFromConfigFile(FileInfo kubeconfig, string currentContext = null, string masterUrl = null, bool useRelativePaths = true) { return BuildConfigFromConfigFileAsync(kubeconfig, currentContext, masterUrl, useRelativePaths).GetAwaiter().GetResult(); } /// /// Initializes a new instance of the from config file /// /// Fileinfo of the kubeconfig, cannot be null /// override the context in config file, set null if do not want to override /// override the kube api server endpoint, set null if do not want to override /// When , the paths in the kubeconfig file will be considered to be relative to the directory in which the kubeconfig /// file is located. When , the paths will be considered to be relative to the current working directory. public static async Task BuildConfigFromConfigFileAsync(FileInfo kubeconfig, string currentContext = null, string masterUrl = null, bool useRelativePaths = true) { if (kubeconfig == null) { throw new NullReferenceException(nameof(kubeconfig)); } var k8SConfig = await LoadKubeConfigAsync(kubeconfig, useRelativePaths).ConfigureAwait(false); var k8SConfiguration = GetKubernetesClientConfiguration(currentContext, masterUrl, k8SConfig); return k8SConfiguration; } /// /// Initializes a new instance of the from config file /// /// Stream of the kubeconfig, cannot be null /// Override the current context in config, set null if do not want to override /// Override the Kubernetes API server endpoint, set null if do not want to override public static KubernetesClientConfiguration BuildConfigFromConfigFile(Stream kubeconfig, string currentContext = null, string masterUrl = null) { return BuildConfigFromConfigFileAsync(kubeconfig, currentContext, masterUrl).GetAwaiter().GetResult(); } /// /// Initializes a new instance of the from config file /// /// Stream of the kubeconfig, cannot be null /// Override the current context in config, set null if do not want to override /// Override the Kubernetes API server endpoint, set null if do not want to override public static async Task BuildConfigFromConfigFileAsync(Stream kubeconfig, string currentContext = null, string masterUrl = null) { if (kubeconfig == null) { throw new NullReferenceException(nameof(kubeconfig)); } if (!kubeconfig.CanSeek) { throw new Exception("Stream don't support seeking!"); } kubeconfig.Position = 0; var k8SConfig = await Yaml.LoadFromStreamAsync(kubeconfig).ConfigureAwait(false); var k8SConfiguration = GetKubernetesClientConfiguration(currentContext, masterUrl, k8SConfig); return k8SConfiguration; } /// /// Initializes a new instance of from pre-loaded config object. /// /// A , for example loaded from /// Override the current context in config, set null if do not want to override /// Override the Kubernetes API server endpoint, set null if do not want to override public static KubernetesClientConfiguration BuildConfigFromConfigObject(K8SConfiguration k8SConfig, string currentContext = null, string masterUrl = null) => GetKubernetesClientConfiguration(currentContext, masterUrl, k8SConfig); private static KubernetesClientConfiguration GetKubernetesClientConfiguration(string currentContext, string masterUrl, K8SConfiguration k8SConfig) { var k8SConfiguration = new KubernetesClientConfiguration(); currentContext = currentContext ?? k8SConfig.CurrentContext; // only init context if context is set if (currentContext != null) { k8SConfiguration.InitializeContext(k8SConfig, currentContext); } if (!string.IsNullOrWhiteSpace(masterUrl)) { k8SConfiguration.Host = masterUrl; } if (string.IsNullOrWhiteSpace(k8SConfiguration.Host)) { throw new KubeConfigException("Cannot infer server host url either from context or masterUrl"); } return k8SConfiguration; } /// /// Validates and Intializes Client Configuration /// /// Kubernetes Configuration /// Current Context private void InitializeContext(K8SConfiguration k8SConfig, string currentContext) { // current context var activeContext = k8SConfig.Contexts.FirstOrDefault( c => c.Name.Equals(currentContext, StringComparison.OrdinalIgnoreCase)); if (activeContext == null) { throw new KubeConfigException($"CurrentContext: {currentContext} not found in contexts in kubeconfig"); } if (string.IsNullOrEmpty(activeContext.ContextDetails?.Cluster)) { // This serves as validation for any of the properties of ContextDetails being set. // Other locations in code assume that ContextDetails is non-null. throw new KubeConfigException($"Cluster not set for context `{currentContext}` in kubeconfig"); } CurrentContext = activeContext.Name; // cluster SetClusterDetails(k8SConfig, activeContext); // user SetUserDetails(k8SConfig, activeContext); // namespace Namespace = activeContext.ContextDetails?.Namespace; } private void SetClusterDetails(K8SConfiguration k8SConfig, Context activeContext) { var clusterDetails = k8SConfig.Clusters.FirstOrDefault(c => c.Name.Equals(activeContext.ContextDetails.Cluster, StringComparison.OrdinalIgnoreCase)); if (clusterDetails?.ClusterEndpoint == null) { throw new KubeConfigException($"Cluster not found for context `{activeContext}` in kubeconfig"); } if (string.IsNullOrWhiteSpace(clusterDetails.ClusterEndpoint.Server)) { throw new KubeConfigException($"Server not found for current-context `{activeContext}` in kubeconfig"); } Host = clusterDetails.ClusterEndpoint.Server; SkipTlsVerify = clusterDetails.ClusterEndpoint.SkipTlsVerify; if (!Uri.TryCreate(Host, UriKind.Absolute, out Uri uri)) { throw new KubeConfigException($"Bad server host URL `{Host}` (cannot be parsed)"); } if (uri.Scheme == "https") { if (!string.IsNullOrEmpty(clusterDetails.ClusterEndpoint.CertificateAuthorityData)) { var data = clusterDetails.ClusterEndpoint.CertificateAuthorityData; SslCaCerts = new X509Certificate2Collection(new X509Certificate2(Convert.FromBase64String(data))); } else if (!string.IsNullOrEmpty(clusterDetails.ClusterEndpoint.CertificateAuthority)) { SslCaCerts = new X509Certificate2Collection(new X509Certificate2(GetFullPath(k8SConfig, clusterDetails.ClusterEndpoint.CertificateAuthority))); } } } private void SetUserDetails(K8SConfiguration k8SConfig, Context activeContext) { if (string.IsNullOrWhiteSpace(activeContext.ContextDetails.User)) { return; } var userDetails = k8SConfig.Users.FirstOrDefault(c => c.Name.Equals(activeContext.ContextDetails.User, StringComparison.OrdinalIgnoreCase)); if (userDetails == null) { throw new KubeConfigException($"User not found for context {activeContext.Name} in kubeconfig"); } if (userDetails.UserCredentials == null) { throw new KubeConfigException($"User credentials not found for user: {userDetails.Name} in kubeconfig"); } var userCredentialsFound = false; // Basic and bearer tokens are mutually exclusive if (!string.IsNullOrWhiteSpace(userDetails.UserCredentials.Token)) { AccessToken = userDetails.UserCredentials.Token; userCredentialsFound = true; } else if (!string.IsNullOrWhiteSpace(userDetails.UserCredentials.UserName) && !string.IsNullOrWhiteSpace(userDetails.UserCredentials.Password)) { Username = userDetails.UserCredentials.UserName; Password = userDetails.UserCredentials.Password; userCredentialsFound = true; } // Token and cert based auth can co-exist if (!string.IsNullOrWhiteSpace(userDetails.UserCredentials.ClientCertificateData) && !string.IsNullOrWhiteSpace(userDetails.UserCredentials.ClientKeyData)) { ClientCertificateData = userDetails.UserCredentials.ClientCertificateData; ClientCertificateKeyData = userDetails.UserCredentials.ClientKeyData; userCredentialsFound = true; } if (!string.IsNullOrWhiteSpace(userDetails.UserCredentials.ClientCertificate) && !string.IsNullOrWhiteSpace(userDetails.UserCredentials.ClientKey)) { ClientCertificateFilePath = GetFullPath(k8SConfig, userDetails.UserCredentials.ClientCertificate); ClientKeyFilePath = GetFullPath(k8SConfig, userDetails.UserCredentials.ClientKey); userCredentialsFound = true; } if (userDetails.UserCredentials.AuthProvider != null) { if (userDetails.UserCredentials.AuthProvider.Config != null && userDetails.UserCredentials.AuthProvider.Config.ContainsKey("access-token")) { switch (userDetails.UserCredentials.AuthProvider.Name) { case "azure": { var config = userDetails.UserCredentials.AuthProvider.Config; if (config.ContainsKey("expires-on")) { var expiresOn = Int32.Parse(config["expires-on"]); DateTimeOffset expires; #if NET452 var epoch = new DateTimeOffset(1970, 1, 1, 0, 0, 0, TimeSpan.Zero); expires = epoch.AddSeconds(expiresOn); #else expires = DateTimeOffset.FromUnixTimeSeconds(expiresOn); #endif if (DateTimeOffset.Compare(expires , DateTimeOffset.Now) <= 0) { var tenantId = config["tenant-id"]; var clientId = config["client-id"]; var apiServerId = config["apiserver-id"]; var refresh = config["refresh-token"]; var newToken = RenewAzureToken(tenantId , clientId , apiServerId , refresh); config["access-token"] = newToken; } } AccessToken = config["access-token"]; userCredentialsFound = true; break; } case "gcp": { var config = userDetails.UserCredentials.AuthProvider.Config; const string keyExpire = "expiry"; if (config.ContainsKey(keyExpire)) { if (DateTimeOffset.TryParse(config[keyExpire] , out DateTimeOffset expires)) { if (DateTimeOffset.Compare(expires , DateTimeOffset.Now) <= 0) { throw new KubeConfigException("Refresh not supported."); } } } AccessToken = config["access-token"]; userCredentialsFound = true; break; } } } } #if NETSTANDARD2_0 if (userDetails.UserCredentials.ExternalExecution != null) { if (string.IsNullOrWhiteSpace(userDetails.UserCredentials.ExternalExecution.Command)) throw new KubeConfigException( "External command execution to receive user credentials must include a command to execute"); if (string.IsNullOrWhiteSpace(userDetails.UserCredentials.ExternalExecution.ApiVersion)) throw new KubeConfigException("External command execution missing ApiVersion key"); var token = ExecuteExternalCommand(userDetails.UserCredentials.ExternalExecution); AccessToken = token; userCredentialsFound = true; } #endif if (!userCredentialsFound) { throw new KubeConfigException( $"User: {userDetails.Name} does not have appropriate auth credentials in kubeconfig"); } } public static string RenewAzureToken(string tenantId, string clientId, string apiServerId, string refresh) { throw new KubeConfigException("Refresh not supported."); } #if NETSTANDARD2_0 /// /// Implementation of the proposal for out-of-tree client /// authentication providers as described here -- /// https://github.com/kubernetes/community/blob/master/contributors/design-proposals/auth/kubectl-exec-plugins.md /// Took inspiration from python exec_provider.py -- /// https://github.com/kubernetes-client/python-base/blob/master/config/exec_provider.py /// /// The external command execution configuration /// The token received from the external commmand execution public static string ExecuteExternalCommand(ExternalExecution config) { var execInfo = new Dictionary { {"apiVersion", config.ApiVersion}, {"kind", "ExecCredentials"}, {"spec", new Dictionary { {"interactive", Environment.UserInteractive} }} }; var process = new Process(); process.StartInfo.Environment.Add("KUBERNETES_EXEC_INFO", JsonConvert.SerializeObject(execInfo)); if (config.EnvironmentVariables != null) foreach (var configEnvironmentVariableKey in config.EnvironmentVariables.Keys) process.StartInfo.Environment.Add(key: configEnvironmentVariableKey, value: config.EnvironmentVariables[configEnvironmentVariableKey]); process.StartInfo.FileName = config.Command; if (config.Arguments != null) process.StartInfo.Arguments = string.Join(" ", config.Arguments); process.StartInfo.RedirectStandardOutput = true; process.StartInfo.RedirectStandardError = true; process.StartInfo.UseShellExecute = false; try { process.Start(); } catch (Exception ex) { throw new KubeConfigException($"external exec failed due to: {ex.Message}"); } var stdout = process.StandardOutput.ReadToEnd(); var stderr = process.StandardOutput.ReadToEnd(); if (string.IsNullOrWhiteSpace(stderr) == false) throw new KubeConfigException($"external exec failed due to: {stderr}"); // Wait for a maximum of 5 seconds, if a response takes longer probably something went wrong... process.WaitForExit(5); try { var responseObject = JsonConvert.DeserializeObject(stdout); if (responseObject == null || responseObject.ApiVersion != config.ApiVersion) throw new KubeConfigException( $"external exec failed because api version {responseObject.ApiVersion} does not match {config.ApiVersion}"); return responseObject.Status["token"]; } catch (JsonSerializationException ex) { throw new KubeConfigException($"external exec failed due to failed deserialization process: {ex}"); } catch (Exception ex) { throw new KubeConfigException($"external exec failed due to uncaught exception: {ex}"); } } #endif /// /// Loads entire Kube Config from default or explicit file path /// /// Explicit file path to kubeconfig. Set to null to use the default file path /// When , the paths in the kubeconfig file will be considered to be relative to the directory in which the kubeconfig /// file is located. When , the paths will be considered to be relative to the current working directory. /// Instance of the class public static async Task LoadKubeConfigAsync(string kubeconfigPath = null, bool useRelativePaths = true) { var fileInfo = new FileInfo(kubeconfigPath ?? KubeConfigDefaultLocation); return await LoadKubeConfigAsync(fileInfo, useRelativePaths).ConfigureAwait(false); } /// /// Loads entire Kube Config from default or explicit file path /// /// Explicit file path to kubeconfig. Set to null to use the default file path /// When , the paths in the kubeconfig file will be considered to be relative to the directory in which the kubeconfig /// file is located. When , the paths will be considered to be relative to the current working directory. /// Instance of the class public static K8SConfiguration LoadKubeConfig(string kubeconfigPath = null, bool useRelativePaths = true) { return LoadKubeConfigAsync(kubeconfigPath, useRelativePaths).GetAwaiter().GetResult(); } /// /// Loads Kube Config /// /// Kube config file contents /// When , the paths in the kubeconfig file will be considered to be relative to the directory in which the kubeconfig /// file is located. When , the paths will be considered to be relative to the current working directory. /// Instance of the class public static async Task LoadKubeConfigAsync(FileInfo kubeconfig, bool useRelativePaths = true) { if (!kubeconfig.Exists) { throw new KubeConfigException($"kubeconfig file not found at {kubeconfig.FullName}"); } using (var stream = kubeconfig.OpenRead()) { var config = await Yaml.LoadFromStreamAsync(stream).ConfigureAwait(false); if (useRelativePaths) { config.FileName = kubeconfig.FullName; } return config; } } /// /// Loads Kube Config /// /// Kube config file contents /// When , the paths in the kubeconfig file will be considered to be relative to the directory in which the kubeconfig /// file is located. When , the paths will be considered to be relative to the current working directory. /// Instance of the class public static K8SConfiguration LoadKubeConfig(FileInfo kubeconfig, bool useRelativePaths = true) { return LoadKubeConfigAsync(kubeconfig, useRelativePaths).GetAwaiter().GetResult(); } /// /// Loads Kube Config /// /// Kube config file contents stream /// Instance of the class public static async Task LoadKubeConfigAsync(Stream kubeconfigStream) { return await Yaml.LoadFromStreamAsync(kubeconfigStream).ConfigureAwait(false); } /// /// Loads Kube Config /// /// Kube config file contents stream /// Instance of the class public static K8SConfiguration LoadKubeConfig(Stream kubeconfigStream) { return LoadKubeConfigAsync(kubeconfigStream).GetAwaiter().GetResult(); } /// /// Tries to get the full path to a file referenced from the Kubernetes configuration. /// /// /// The Kubernetes configuration. /// /// /// The path to resolve. /// /// /// When possible a fully qualified path to the file. /// /// /// For example, if the configuration file is at "C:\Users\me\kube.config" and path is "ca.crt", /// this will return "C:\Users\me\ca.crt". Similarly, if path is "D:\ca.cart", this will return /// "D:\ca.crt". /// private static string GetFullPath(K8SConfiguration configuration, string path) { // If we don't have a file name, if (string.IsNullOrWhiteSpace(configuration.FileName) || Path.IsPathRooted(path)) { return path; } else { return Path.Combine(Path.GetDirectoryName(configuration.FileName), path); } } } }