// Copyright (C) The Arvados Authors. All rights reserved. // // SPDX-License-Identifier: AGPL-3.0 package config import ( "encoding/json" "errors" "fmt" "io" "strings" "git.arvados.org/arvados.git/sdk/go/arvados" ) // ExportJSON writes a JSON object with the safe (non-secret) portions // of the cluster config to w. func ExportJSON(w io.Writer, cluster *arvados.Cluster) error { buf, err := json.Marshal(cluster) if err != nil { return err } var m map[string]interface{} err = json.Unmarshal(buf, &m) if err != nil { return err } // ClusterID is not marshalled by default (see `json:"-"`). // Add it back here so it is included in the exported config. m["ClusterID"] = cluster.ClusterID err = redactUnsafe(m, "", "") if err != nil { return err } return json.NewEncoder(w).Encode(m) } // whitelist classifies configs as safe/unsafe to reveal through the API // endpoint. Note that endpoint does not require authentication. // // Every config entry must either be listed explicitly here along with // all of its parent keys (e.g., "API" + "API.RequestTimeout"), or // have an ancestor listed as false (e.g., // "PostgreSQL.Connection.password" has an ancestor // "PostgreSQL.Connection" with a false value). Otherwise, it is a bug // which should be caught by tests. // // Example: API.RequestTimeout is safe because whitelist["API"] == and // whitelist["API.RequestTimeout"] == true. // // Example: PostgreSQL.Connection.password is not safe because // whitelist["PostgreSQL.Connection"] == false. // // Example: PostgreSQL.BadKey would cause an error because // whitelist["PostgreSQL"] isn't false, and neither // whitelist["PostgreSQL.BadKey"] nor whitelist["PostgreSQL.*"] // exists. var whitelist = map[string]bool{ // | sort -t'"' -k2,2 "API": true, "API.AsyncPermissionsUpdateInterval": false, "API.DisabledAPIs": false, "API.FreezeProjectRequiresDescription": true, "API.FreezeProjectRequiresProperties": true, "API.FreezeProjectRequiresProperties.*": true, "API.KeepServiceRequestTimeout": false, "API.LockBeforeUpdate": false, "API.MaxConcurrentRailsRequests": false, "API.MaxConcurrentRequests": false, "API.MaxGatewayTunnels": false, "API.MaxIndexDatabaseRead": false, "API.MaxItemsPerResponse": true, "API.MaxKeepBlobBuffers": false, "API.MaxQueuedRequests": false, "API.MaxQueueTimeForLockRequests": false, "API.MaxRequestAmplification": false, "API.MaxRequestSize": true, "API.MaxTokenLifetime": false, "API.RequestTimeout": true, "API.SendTimeout": true, "API.UnfreezeProjectRequiresAdmin": true, "API.VocabularyPath": false, "API.WebsocketClientEventQueue": false, "API.WebsocketServerEventQueue": false, "AuditLogs": false, "AuditLogs.MaxAge": false, "AuditLogs.MaxDeleteBatch": false, "AuditLogs.UnloggedAttributes": false, "ClusterID": true, "Collections": true, "Collections.BalanceCollectionBatch": false, "Collections.BalanceCollectionBuffers": false, "Collections.BalancePeriod": false, "Collections.BalancePullLimit": false, "Collections.BalanceTimeout": false, "Collections.BalanceTrashLimit": false, "Collections.BalanceUpdateLimit": false, "Collections.BlobDeleteConcurrency": false, "Collections.BlobMissingReport": false, "Collections.BlobReplicateConcurrency": false, "Collections.BlobSigning": true, "Collections.BlobSigningKey": false, "Collections.BlobSigningTTL": true, "Collections.BlobTrash": false, "Collections.BlobTrashCheckInterval": false, "Collections.BlobTrashConcurrency": false, "Collections.BlobTrashLifetime": false, "Collections.CollectionVersioning": true, "Collections.DefaultReplication": true, "Collections.DefaultTrashLifetime": true, "Collections.ForwardSlashNameSubstitution": true, "Collections.KeepproxyPermission": false, "Collections.ManagedProperties": true, "Collections.ManagedProperties.*": true, "Collections.ManagedProperties.*.*": true, "Collections.PreserveVersionIfIdle": true, "Collections.S3FolderObjects": true, "Collections.TrashSweepInterval": false, "Collections.TrustAllContent": true, "Collections.WebDAVCache": false, "Collections.WebDAVLogEvents": false, "Collections.WebDAVLogDownloadInterval": false, "Collections.WebDAVOutputBuffer": false, "Collections.WebDAVPermission": false, "Containers": true, "Containers.AlwaysUsePreemptibleInstances": true, "Containers.CloudVMs": false, "Containers.CrunchRunArgumentsList": false, "Containers.CrunchRunCommand": false, "Containers.DefaultKeepCacheRAM": true, "Containers.DispatchPrivateKey": false, "Containers.LocalKeepBlobBuffersPerVCPU": false, "Containers.LocalKeepLogsToContainerLog": false, "Containers.Logging": false, "Containers.LogReuseDecisions": false, "Containers.LSF": false, "Containers.MaxDispatchAttempts": false, "Containers.MaximumPriceFactor": true, "Containers.MaxRetryAttempts": true, "Containers.MinRetryPeriod": true, "Containers.PreemptiblePriceFactor": false, "Containers.ReserveExtraRAM": true, "Containers.RuntimeEngine": true, "Containers.ShellAccess": true, "Containers.ShellAccess.Admin": true, "Containers.ShellAccess.User": true, "Containers.SLURM": false, "Containers.StaleLockTimeout": false, "Containers.SupportedDockerImageFormats": true, "Containers.SupportedDockerImageFormats.*": true, "InstanceTypes": true, "InstanceTypes.*": true, "InstanceTypes.*.*": true, "InstanceTypes.*.*.*": true, "Login": true, "Login.Google": true, "Login.Google.AlternateEmailAddresses": false, "Login.Google.AuthenticationRequestParameters": false, "Login.Google.ClientID": false, "Login.Google.ClientSecret": false, "Login.Google.Enable": true, "Login.IssueTrustedTokens": false, "Login.LDAP": true, "Login.LDAP.AppendDomain": false, "Login.LDAP.EmailAttribute": false, "Login.LDAP.Enable": true, "Login.LDAP.InsecureTLS": false, "Login.LDAP.MinTLSVersion": false, "Login.LDAP.SearchAttribute": false, "Login.LDAP.SearchBase": false, "Login.LDAP.SearchBindPassword": false, "Login.LDAP.SearchBindUser": false, "Login.LDAP.SearchFilters": false, "Login.LDAP.StartTLS": false, "Login.LDAP.StripDomain": false, "Login.LDAP.URL": false, "Login.LDAP.UsernameAttribute": false, "Login.LoginCluster": true, "Login.OpenIDConnect": true, "Login.OpenIDConnect.AcceptAccessToken": false, "Login.OpenIDConnect.AcceptAccessTokenScope": false, "Login.OpenIDConnect.AuthenticationRequestParameters": false, "Login.OpenIDConnect.ClientID": false, "Login.OpenIDConnect.ClientSecret": false, "Login.OpenIDConnect.EmailClaim": false, "Login.OpenIDConnect.EmailVerifiedClaim": false, "Login.OpenIDConnect.Enable": true, "Login.OpenIDConnect.Issuer": false, "Login.OpenIDConnect.UsernameClaim": false, "Login.PAM": true, "Login.PAM.DefaultEmailDomain": false, "Login.PAM.Enable": true, "Login.PAM.Service": false, "Login.RemoteTokenRefresh": true, "Login.Test": true, "Login.Test.Enable": true, "Login.Test.Users": false, "Login.TokenLifetime": false, "Login.TrustedClients": false, "Login.TrustPrivateNetworks": false, "ManagementToken": false, "PostgreSQL": false, "RemoteClusters": true, "RemoteClusters.*": true, "RemoteClusters.*.ActivateUsers": true, "RemoteClusters.*.Host": true, "RemoteClusters.*.Insecure": true, "RemoteClusters.*.Proxy": true, "RemoteClusters.*.Scheme": true, "Services": true, "Services.*": true, "Services.*.ExternalURL": true, "Services.*.InternalURLs": false, "StorageClasses": true, "StorageClasses.*": true, "StorageClasses.*.Default": true, "StorageClasses.*.Priority": true, "SystemLogs": false, "SystemRootToken": false, "TLS": false, "TLS.Certificate": false, "TLS.Insecure": true, "TLS.Key": false, "Users": true, "Users.ActivatedUsersAreVisibleToOthers": false, "Users.ActivityLoggingPeriod": false, "Users.AdminNotifierEmailFrom": false, "Users.AnonymousUserToken": true, "Users.AutoAdminFirstUser": false, "Users.AutoAdminUserWithEmail": false, "Users.AutoSetupNewUsers": false, "Users.AutoSetupNewUsersWithVmUUID": false, "Users.AutoSetupUsernameBlacklist": false, "Users.CanCreateRoleGroups": true, "Users.EmailSubjectPrefix": false, "Users.NewInactiveUserNotificationRecipients": false, "Users.NewUserNotificationRecipients": false, "Users.NewUsersAreActive": false, "Users.PreferDomainForUsername": false, "Users.RoleGroupsVisibleToAll": false, "Users.SendUserSetupNotificationEmail": false, "Users.SupportEmailAddress": true, "Users.SyncIgnoredGroups": true, "Users.SyncRequiredGroups": true, "Users.SyncUserAccounts": true, "Users.SyncUserAPITokens": true, "Users.SyncUserGroups": true, "Users.SyncUserSSHKeys": true, "Users.UserNotifierEmailBcc": false, "Users.UserNotifierEmailFrom": false, "Users.UserProfileNotificationAddress": false, "Users.UserSetupMailText": false, "Volumes": true, "Volumes.*": true, "Volumes.*.*": false, "Volumes.*.AccessViaHosts": true, "Volumes.*.AccessViaHosts.*": true, "Volumes.*.AccessViaHosts.*.ReadOnly": true, "Volumes.*.ReadOnly": true, "Volumes.*.Replication": true, "Volumes.*.StorageClasses": true, "Volumes.*.StorageClasses.*": true, "Workbench": true, "Workbench.ActivationContactLink": false, "Workbench.APIClientConnectTimeout": true, "Workbench.APIClientReceiveTimeout": true, "Workbench.APIResponseCompression": true, "Workbench.ApplicationMimetypesWithViewIcon": true, "Workbench.ApplicationMimetypesWithViewIcon.*": true, "Workbench.ArvadosDocsite": true, "Workbench.ArvadosPublicDataDocURL": true, "Workbench.BannerUUID": true, "Workbench.DefaultOpenIdPrefix": false, "Workbench.DisableSharingURLsUI": true, "Workbench.EnableGettingStartedPopup": true, "Workbench.EnablePublicProjectsPage": true, "Workbench.FileViewersConfigURL": true, "Workbench.IdleTimeout": true, "Workbench.InactivePageHTML": true, "Workbench.LogViewerMaxBytes": true, "Workbench.MultiSiteSearch": true, "Workbench.ProfilingEnabled": true, "Workbench.Repositories": false, "Workbench.RepositoryCache": false, "Workbench.RunningJobLogRecordsToFetch": true, "Workbench.ShowRecentCollectionsOnDashboard": true, "Workbench.ShowUserAgreementInline": true, "Workbench.ShowUserNotifications": true, "Workbench.SiteName": true, "Workbench.SSHHelpHostSuffix": true, "Workbench.SSHHelpPageHTML": true, "Workbench.Theme": true, "Workbench.UserProfileFormFields": true, "Workbench.UserProfileFormFields.*": true, "Workbench.UserProfileFormFields.*.*": true, "Workbench.UserProfileFormFields.*.*.*": true, "Workbench.UserProfileFormMessage": true, "Workbench.WelcomePageHTML": true, } func redactUnsafe(m map[string]interface{}, mPrefix, lookupPrefix string) error { var errs []string for k, v := range m { lookupKey := k safe, ok := whitelist[lookupPrefix+k] if !ok { lookupKey = "*" safe, ok = whitelist[lookupPrefix+"*"] } if !ok { errs = append(errs, fmt.Sprintf("config bug: key %q not in whitelist map", lookupPrefix+k)) continue } if !safe { delete(m, k) continue } if v, ok := v.(map[string]interface{}); ok { err := redactUnsafe(v, mPrefix+k+".", lookupPrefix+lookupKey+".") if err != nil { errs = append(errs, err.Error()) } } } if len(errs) > 0 { return errors.New(strings.Join(errs, "\n")) } return nil }