// Copyright 2015 Google Inc. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // cloudsql-proxy can be used as a proxy to Cloud SQL databases. It supports // connecting to many instances and authenticating via different means. // Specifically, a list of instances may be provided on the command line, in // GCE metadata (for VMs), or provided during connection time via a // FUSE-mounted directory. See flags for a more specific explanation. package main import ( "errors" "flag" "fmt" "io/ioutil" "net/http" "os" "os/signal" "path/filepath" "strings" "sync" "syscall" "time" "github.com/GoogleCloudPlatform/cloudsql-proxy/cmd/cloud_sql_proxy/internal/healthcheck" "github.com/GoogleCloudPlatform/cloudsql-proxy/logging" "github.com/GoogleCloudPlatform/cloudsql-proxy/proxy/certs" "github.com/GoogleCloudPlatform/cloudsql-proxy/proxy/fuse" "github.com/GoogleCloudPlatform/cloudsql-proxy/proxy/limits" "github.com/GoogleCloudPlatform/cloudsql-proxy/proxy/proxy" "github.com/GoogleCloudPlatform/cloudsql-proxy/proxy/util" "cloud.google.com/go/compute/metadata" "github.com/coreos/go-systemd/v22/daemon" "golang.org/x/net/context" "golang.org/x/oauth2" goauth "golang.org/x/oauth2/google" sqladmin "google.golang.org/api/sqladmin/v1beta4" ) var ( version = flag.Bool("version", false, "Print the version of the proxy and exit") verbose = flag.Bool("verbose", true, `If false, verbose output such as information about when connections are created/closed without error are suppressed`, ) quiet = flag.Bool("quiet", false, "Disable log messages") logDebugStdout = flag.Bool("log_debug_stdout", false, "If true, log messages that are not errors will output to stdout instead of stderr") structuredLogs = flag.Bool("structured_logs", false, "Configures all log messages to be emitted as JSON.") refreshCfgThrottle = flag.Duration("refresh_config_throttle", proxy.DefaultRefreshCfgThrottle, `If set, this flag specifies the amount of forced sleep between successive API calls in order to protect client API quota. Minimum allowed value is `+minimumRefreshCfgThrottle.String(), ) checkRegion = flag.Bool("check_region", false, `If specified, the 'region' portion of the connection string is required for Unix socket-based connections.`) // Settings for how to choose which instance to connect to. dir = flag.String("dir", "", "Directory to use for placing Unix sockets representing database instances") projects = flag.String("projects", "", `Open sockets for each Cloud SQL Instance in the projects specified (comma-separated list)`, ) instances stringListValue // -instances flag is defined in runProxy() instanceSrc = flag.String("instances_metadata", "", `If provided, it is treated as a path to a metadata value which is polled for a comma-separated list of instances to connect to. For example, to use the instance metadata value named 'cloud-sql-instances' you would provide 'instance/attributes/cloud-sql-instances'. Not compatible with -fuse`) useFuse = flag.Bool("fuse", false, `Mount a directory at 'dir' using FUSE for accessing instances. Note that the directory at 'dir' must be empty before this program is started.`) fuseTmp = flag.String("fuse_tmp", defaultTmp, `Used as a temporary directory if -fuse is set. Note that files in this directory can be removed automatically by this program.`) // Settings for limits maxConnections = flag.Uint64("max_connections", 0, `If provided, the maximum number of connections to establish before refusing new connections. Defaults to 0 (no limit)`, ) fdRlimit = flag.Uint64("fd_rlimit", limits.ExpectedFDs, `Sets the rlimit on the number of open file descriptors for the proxy to the provided value. If set to zero, disables attempts to set the rlimit. Defaults to a value which can support 4K connections to one instance`, ) termTimeout = flag.Duration("term_timeout", 0, `When set, the proxy will wait for existing connections to close before terminating. Any connections that haven't closed after the timeout will be dropped`, ) // Settings for authentication. token = flag.String("token", "", "When set, the proxy uses this Bearer token for authorization.") tokenFile = flag.String("credential_file", "", `If provided, this json file will be used to retrieve Service Account credentials. You may set the GOOGLE_APPLICATION_CREDENTIALS environment variable for the same effect.`, ) ipAddressTypes = flag.String("ip_address_types", "PUBLIC,PRIVATE", `Default to be 'PUBLIC,PRIVATE'. Options: a list of strings separated by ',', e.g. 'PUBLIC,PRIVATE' `, ) // Settings for IAM db proxy authentication enableIAMLogin = flag.Bool("enable_iam_login", false, "Enables database user authentication using Cloud SQL's IAM DB Authentication (Postgres only).") skipInvalidInstanceConfigs = flag.Bool("skip_failed_instance_config", false, `Setting this flag will allow you to prevent the proxy from terminating when some instance configurations could not be parsed and/or are unavailable.`, ) // Setting to choose what API to connect to host = flag.String("host", "", `When set, the proxy uses this host as the base API path. Example: https://sqladmin.googleapis.com`, ) quotaProject = flag.String("quota_project", "", `Specifies the project to use for Cloud SQL Admin API quota tracking.`) // Settings for healthcheck useHTTPHealthCheck = flag.Bool("use_http_health_check", false, "When set, creates an HTTP server that checks and communicates the health of the proxy client.") healthCheckPort = flag.String("health_check_port", "8090", "When applicable, health checks take place on this port number. Defaults to 8090.") ) const ( minimumRefreshCfgThrottle = time.Second port = 3307 ) func init() { flag.Usage = func() { fmt.Fprintf(os.Stderr, ` The Cloud SQL Auth proxy allows simple, secure connectivity to Google Cloud SQL. It is a long-running process that opens local sockets (either TCP or Unix sockets) according to the parameters passed to it. A local application connects to a Cloud SQL instance by using the corresponding socket. Authorization: * On Google Compute Engine, the default service account is used. The Cloud SQL API must be enabled for the VM. * When the gcloud command-line tool is installed on the local machine, the "active account" is used for authentication. Run 'gcloud auth list' to see which accounts are installed on your local machine and 'gcloud config list account' to view the active account. * To configure the proxy using a service account, pass the -credential_file parameter or set the GOOGLE_APPLICATION_CREDENTIALS environment variable. This will override gcloud or GCE (Google Compute Engine) credentials, if they exist. * To configure the proxy using IAM authentication, pass the -enable_iam_login flag. This will cause the proxy to use IAM account credentials for database user authentication. General: -quiet Disable log messages (e.g. when new connections are established). WARNING: this option disables ALL logging output (including connection errors), which will likely make debugging difficult. The -quiet flag takes precedence over the -verbose flag. -log_debug_stdout When explicitly set to true, verbose and info log messages will be directed to stdout as opposed to the default stderr. -verbose When explicitly set to false, disable log messages that are not errors nor first-time startup messages (e.g. when new connections are established). -structured_logs When set to true, all log messages are written out as JSON. Connection: -instances To connect to a specific list of instances, set the instances parameter to a comma-separated list of instance connection strings. For example: -instances=my-project:my-region:my-instance For convenience, this flag may be specified multiple times. For connectivity over TCP, you must specify a tcp port as part of the instance string. For example, the following example opens a loopback TCP socket on port 3306, which will be proxied to connect to the instance 'my-instance' in project 'my-project'. To listen on other interfaces than localhost, a custom bind address (e.g., 0.0.0.0) may be provided. For example: -instances=my-project:my-region:my-instance=tcp:3306 or -instances=my-project:my-region:my-instance=tcp:0.0.0.0:3306 When connecting over TCP, the -instances parameter is required. To set a custom socket name, you can specify it as part of the instance string. The following example opens a unix socket in the directory specified by -dir, which will be proxied to connect to the instance 'my-instance' in project 'my-project': -instances=my-project:my-region:my-instance=unix:custom-socket-name Note: The directory specified by -dir must exist and the socket file path (i.e., dir plus INSTANCE_CONNECTION_NAME) must be under your platform's limit (typically 108 characters on many Unix systems, but varies by platform). To override the -dir parameter, specify an absolute path as shown in the following example: -instances=my-project:my-region:my-instance=unix:/my/custom/sql-socket Supplying INSTANCES environment variable achieves the same effect. One can use that to keep k8s manifest files constant across multiple environments -instances_metadata When running on GCE (Google Compute Engine) you can avoid the need to specify the list of instances on the command line by using the Metadata server. This parameter specifies a path to a metadata value which is then interpreted as a list of instances in the exact same way as the -instances parameter. Updates to the metadata value will be observed and acted on by the Proxy. -projects To direct the proxy to allow connections to all instances in specific projects, set the projects parameter: -projects=my-project -fuse If your local environment has FUSE installed, you can specify the -fuse flag to avoid the requirement to specify instances in advance. With FUSE, any attempts to open a Unix socket in the directory specified by -dir automatically creates that socket and connects to the corresponding instance. -dir When using Unix sockets (the default for systems which support them), the Proxy places the sockets in the directory specified by the -dir parameter. Automatic instance discovery: If the Google Cloud SQL is installed on the local machine and no instance connection flags are specified, the proxy connects to all instances in the gcloud tool's active project. Run 'gcloud config list project' to display the active project. Information for all flags: `) flag.VisitAll(func(f *flag.Flag) { usage := strings.Replace(f.Usage, "\n", "\n ", -1) fmt.Fprintf(os.Stderr, " -%s\n %s\n\n", f.Name, usage) }) } } var defaultTmp = filepath.Join(os.TempDir(), "cloudsql-proxy-tmp") // versionString indiciates the version of the proxy currently in use. var versionString = "1.28.0" // metadataString indiciates additional build or distribution metadata. var metadataString = "" // semanticVersion returns the version of the proxy in a semver format. func semanticVersion() string { v := versionString if metadataString != "" { v += "+" + metadataString } return v } // userAgentFromVersionString returns an appropriate user agent string for identifying this proxy process. func userAgentFromVersionString() string { return "cloud_sql_proxy/" + semanticVersion() } const accountErrorSuffix = `Please create a new VM with Cloud SQL access (scope) enabled under "Identity and API access". Alternatively, create a new "service account key" and specify it using the -credential_file parameter` type stringListValue []string func (i *stringListValue) String() string { return strings.Join(*i, ",") } func (i *stringListValue) Set(s string) error { *i = append(*i, stringList(s)...) return nil } func checkFlags(onGCE bool) error { if !onGCE { if *instanceSrc != "" { return errors.New("-instances_metadata unsupported outside of Google Compute Engine") } return nil } if *token != "" || *tokenFile != "" || os.Getenv("GOOGLE_APPLICATION_CREDENTIALS") != "" { return nil } // Check if gcloud credentials are available and if so, skip checking the GCE VM service account scope. _, err := util.GcloudConfig() if err == nil { return nil } scopes, err := metadata.Scopes("default") if err != nil { if _, ok := err.(metadata.NotDefinedError); ok { return errors.New("no service account found for this Compute Engine VM. " + accountErrorSuffix) } return fmt.Errorf("error checking scopes: %T %v | %+v", err, err, err) } ok := false for _, sc := range scopes { if sc == proxy.SQLScope || sc == "https://www.googleapis.com/auth/cloud-platform" { ok = true break } } if !ok { return errors.New(`the default Compute Engine service account is not configured with sufficient permissions to access the Cloud SQL API from this VM. ` + accountErrorSuffix) } return nil } func authenticatedClientFromPath(ctx context.Context, f string) (*http.Client, oauth2.TokenSource, error) { all, err := ioutil.ReadFile(f) if err != nil { return nil, nil, fmt.Errorf("invalid json file %q: %v", f, err) } // First try and load this as a service account config, which allows us to see the service account email: if cfg, err := goauth.JWTConfigFromJSON(all, proxy.SQLScope); err == nil { logging.Infof("using credential file for authentication; email=%s", cfg.Email) return cfg.Client(ctx), cfg.TokenSource(ctx), nil } cred, err := goauth.CredentialsFromJSON(ctx, all, proxy.SQLScope) if err != nil { return nil, nil, fmt.Errorf("invalid json file %q: %v", f, err) } logging.Infof("using credential file for authentication; path=%q", f) return oauth2.NewClient(ctx, cred.TokenSource), cred.TokenSource, nil } func authenticatedClient(ctx context.Context) (*http.Client, oauth2.TokenSource, error) { if *tokenFile != "" { return authenticatedClientFromPath(ctx, *tokenFile) } else if tok := *token; tok != "" { src := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: tok}) return oauth2.NewClient(ctx, src), src, nil } else if f := os.Getenv("GOOGLE_APPLICATION_CREDENTIALS"); f != "" { return authenticatedClientFromPath(ctx, f) } // If flags or env don't specify an auth source, try either gcloud or application default // credentials. src, err := util.GcloudTokenSource(ctx) if err != nil { src, err = goauth.DefaultTokenSource(ctx, proxy.SQLScope) } if err != nil { return nil, nil, err } return oauth2.NewClient(ctx, src), src, nil } // quotaProjectTransport is an http.RoundTripper that adds an X-Goog-User-Project // header to all requests for quota and billing purposes. // // For details, see: // https://cloud.google.com/apis/docs/system-parameters#definitions type quotaProjectTransport struct { base http.RoundTripper project string } var _ http.RoundTripper = quotaProjectTransport{} // RoundTrip adds a X-Goog-User-Project header to each request. func (t quotaProjectTransport) RoundTrip(req *http.Request) (*http.Response, error) { if req.Header == nil { req.Header = make(http.Header) } req.Header.Add("X-Goog-User-Project", t.project) return t.base.RoundTrip(req) } // configureQuotaProject configures an HTTP client to use the provided project // for quota calculations for all requests. func configureQuotaProject(c *http.Client, project string) { // Copy the given client's tripper. Note that tripper can be nil, which is equivalent to // http.DefaultTransport. (See https://golang.org/pkg/net/http/#Client) base := c.Transport if base == nil { base = http.DefaultTransport } c.Transport = quotaProjectTransport{ base: base, project: project, } } func stringList(s string) []string { spl := strings.Split(s, ",") if len(spl) == 1 && spl[0] == "" { return nil } return spl } func listInstances(ctx context.Context, cl *http.Client, projects []string) ([]string, error) { if len(projects) == 0 { // No projects requested. return nil, nil } sql, err := sqladmin.New(cl) if err != nil { return nil, err } if *host != "" { sql.BasePath = *host } ch := make(chan string) var wg sync.WaitGroup wg.Add(len(projects)) for _, proj := range projects { proj := proj go func() { err := sql.Instances.List(proj).Pages(ctx, func(r *sqladmin.InstancesListResponse) error { for _, in := range r.Items { // The Proxy is only support on Second Gen if in.BackendType == "SECOND_GEN" { ch <- in.ConnectionName } } return nil }) if err != nil { logging.Errorf("Error listing instances in %v: %v", proj, err) } wg.Done() }() } go func() { wg.Wait() close(ch) }() var ret []string for x := range ch { ret = append(ret, x) } if len(ret) == 0 { return nil, fmt.Errorf("no Cloud SQL Instances found in these projects: %v", projects) } return ret, nil } func gcloudProject() ([]string, error) { cfg, err := util.GcloudConfig() if err != nil { return nil, err } if cfg.Configuration.Properties.Core.Project == "" { return nil, fmt.Errorf("gcloud has no active project, you can set it by running `gcloud config set project `") } return []string{cfg.Configuration.Properties.Core.Project}, nil } func runProxy() int { flag.Var(&instances, "instances", `Comma-separated list of fully qualified instances (project:region:name) to connect to. If the name has the suffix '=tcp:port', a TCP server is opened on the specified port on localhost to proxy to that instance. It is also possible to listen on a custom address by providing a host, e.g., '=tcp:0.0.0.0:port'. If no value is provided for 'tcp', one socket file per instance is opened in 'dir'. For convenience, this flag may be specified multiple times. You may use the INSTANCES environment variable for the same effect. Using both will use the value from the flag, Not compatible with -fuse.`, ) flag.Parse() if *version { fmt.Println("Cloud SQL Auth proxy:", semanticVersion()) return 0 } if *logDebugStdout { logging.LogDebugToStdout() } if !*verbose { logging.LogVerboseToNowhere() } if *structuredLogs { cleanup, err := logging.EnableStructuredLogs(*logDebugStdout, *verbose) if err != nil { logging.Errorf("failed to enable structured logs: %v", err) return 1 } defer cleanup() } if *quiet { logging.Infof("Cloud SQL Auth proxy logging has been disabled by the -quiet flag. All messages (including errors) will be suppressed.") logging.DisableLogging() } // Split the input ipAddressTypes to the slice of string ipAddrTypeOptsInput := strings.Split(*ipAddressTypes, ",") if *fdRlimit != 0 { if err := limits.SetupFDLimits(*fdRlimit); err != nil { logging.Infof("failed to setup file descriptor limits: %v", err) } } if *host != "" && !strings.HasSuffix(*host, "/") { logging.Errorf("Flag host should always end with /") flag.PrintDefaults() return 0 } // TODO: needs a better place for consolidation // if instances is blank and env var INSTANCES is supplied use it if envInstances := os.Getenv("INSTANCES"); len(instances) == 0 && envInstances != "" { instances.Set(envInstances) } projList := stringList(*projects) // TODO: it'd be really great to consolidate flag verification in one place. if len(instances) == 0 && *instanceSrc == "" && len(projList) == 0 && !*useFuse { var err error projList, err = gcloudProject() if err == nil { logging.Infof("Using gcloud's active project: %v", projList) } else if gErr, ok := err.(*util.GcloudError); ok && gErr.Status == util.GcloudNotFound { logging.Errorf("gcloud is not in the path and -instances and -projects are empty") return 1 } else { logging.Errorf("unable to retrieve the active gcloud project and -instances and -projects are empty: %v", err) return 1 } } onGCE := metadata.OnGCE() if err := checkFlags(onGCE); err != nil { logging.Errorf(err.Error()) return 1 } ctx, cancel := context.WithCancel(context.Background()) client, tokSrc, err := authenticatedClient(ctx) if err != nil { logging.Errorf(err.Error()) return 1 } if *quotaProject != "" { logging.Infof("Using the project %q for SQL Admin API quota", *quotaProject) configureQuotaProject(client, *quotaProject) } ins, err := listInstances(ctx, client, projList) if err != nil { logging.Errorf(err.Error()) return 1 } instances = append(instances, ins...) cfgs, err := CreateInstanceConfigs(*dir, *useFuse, instances, *instanceSrc, client, *skipInvalidInstanceConfigs) if err != nil { logging.Errorf(err.Error()) return 1 } // We only need to store connections in a ConnSet if FUSE is used; otherwise // it is not efficient to do so. var connset *proxy.ConnSet if *useFuse { connset = proxy.NewConnSet() } // Create proxy client first; fuse uses its cache to resolve database version. refreshCfgThrottle := *refreshCfgThrottle if refreshCfgThrottle < minimumRefreshCfgThrottle { refreshCfgThrottle = minimumRefreshCfgThrottle } refreshCfgBuffer := proxy.DefaultRefreshCfgBuffer if *enableIAMLogin { refreshCfgThrottle = proxy.IAMLoginRefreshThrottle refreshCfgBuffer = proxy.IAMLoginRefreshCfgBuffer } proxyClient := &proxy.Client{ Port: port, MaxConnections: *maxConnections, Certs: certs.NewCertSourceOpts(client, certs.RemoteOpts{ APIBasePath: *host, IgnoreRegion: !*checkRegion, UserAgent: userAgentFromVersionString(), IPAddrTypeOpts: ipAddrTypeOptsInput, EnableIAMLogin: *enableIAMLogin, TokenSource: tokSrc, }), Conns: connset, RefreshCfgThrottle: refreshCfgThrottle, RefreshCfgBuffer: refreshCfgBuffer, } var hc *healthcheck.Server if *useHTTPHealthCheck { // Extract a list of all instances specified statically. List is empty when in fuse mode. var insts []string for _, cfg := range cfgs { insts = append(insts, cfg.Instance) } hc, err = healthcheck.NewServer(proxyClient, *healthCheckPort, insts) if err != nil { logging.Errorf("[Health Check] Could not initialize health check server: %v", err) return 1 } defer hc.Close(ctx) } // Initialize a source of new connections to Cloud SQL instances. var connSrc <-chan proxy.Conn if *useFuse { c, fuse, err := fuse.NewConnSrc(*dir, *fuseTmp, proxyClient, connset) if err != nil { logging.Errorf("Could not start fuse directory at %q: %v", *dir, err) return 1 } connSrc = c defer fuse.Close() } else { updates := make(chan string) if *instanceSrc != "" { go func() { for { err := metadata.Subscribe(*instanceSrc, func(v string, ok bool) error { if ok { updates <- v } return nil }) if err != nil { logging.Errorf("Error on receiving new instances from metadata: %v", err) } time.Sleep(5 * time.Second) } }() } c, err := WatchInstances(*dir, cfgs, updates, client) if err != nil { logging.Errorf(err.Error()) return 1 } connSrc = c } logging.Infof("Ready for new connections") if hc != nil { hc.NotifyStarted() } signals := make(chan os.Signal, 1) signal.Notify(signals, syscall.SIGTERM, syscall.SIGINT) shutdown := make(chan int, 1) go func() { defer func() { cancel(); close(shutdown) }() <-signals logging.Infof("Received TERM signal. Waiting up to %s before terminating.", *termTimeout) go func() { if _, err := daemon.SdNotify(false, daemon.SdNotifyStopping); err != nil { logging.Errorf("Failed to notify systemd of termination: %v", err) } }() err := proxyClient.Shutdown(*termTimeout) if err != nil { logging.Errorf("Error during SIGTERM shutdown: %v", err) shutdown <- 2 return } }() // If running under systemd with Type=notify, we'll send a message to the // service manager that we are ready to handle connections now, and any other // units that are waiting for us can start. go func() { if _, err := daemon.SdNotify(false, daemon.SdNotifyReady); err != nil { logging.Errorf("Failed to notify systemd of readiness: %v", err) } }() proxyClient.RunContext(ctx, connSrc) if code, ok := <-shutdown; ok { return code } return 0 } func main() { code := runProxy() os.Exit(code) }