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
|
// Copyright 2017 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.
// Package firebase is the entry point to the Firebase Admin SDK. It provides functionality for initializing App
// instances, which serve as the central entities that provide access to various other Firebase services exposed
// from the SDK.
package firebase
import (
"context"
"encoding/json"
"errors"
"io/ioutil"
"os"
"cloud.google.com/go/firestore"
"firebase.google.com/go/v4/appcheck"
"firebase.google.com/go/v4/auth"
"firebase.google.com/go/v4/db"
"firebase.google.com/go/v4/iid"
"firebase.google.com/go/v4/internal"
"firebase.google.com/go/v4/messaging"
"firebase.google.com/go/v4/remoteconfig"
"firebase.google.com/go/v4/storage"
"google.golang.org/api/option"
"google.golang.org/api/transport"
)
var defaultAuthOverrides = make(map[string]interface{})
// Version of the Firebase Go Admin SDK.
const Version = "4.18.0"
// firebaseEnvName is the name of the environment variable with the Config.
const firebaseEnvName = "FIREBASE_CONFIG"
// An App holds configuration and state common to all Firebase services that are exposed from the SDK.
type App struct {
authOverride map[string]interface{}
dbURL string
projectID string
serviceAccountID string
storageBucket string
opts []option.ClientOption
}
// Config represents the configuration used to initialize an App.
type Config struct {
AuthOverride *map[string]interface{} `json:"databaseAuthVariableOverride"`
DatabaseURL string `json:"databaseURL"`
ProjectID string `json:"projectId"`
ServiceAccountID string `json:"serviceAccountId"`
StorageBucket string `json:"storageBucket"`
}
// Auth returns an instance of auth.Client.
func (a *App) Auth(ctx context.Context) (*auth.Client, error) {
conf := &internal.AuthConfig{
ProjectID: a.projectID,
Opts: a.opts,
ServiceAccountID: a.serviceAccountID,
Version: Version,
}
return auth.NewClient(ctx, conf)
}
// Database returns an instance of db.Client to interact with the default Firebase Database
// configured via Config.DatabaseURL.
func (a *App) Database(ctx context.Context) (*db.Client, error) {
return a.DatabaseWithURL(ctx, a.dbURL)
}
// DatabaseWithURL returns an instance of db.Client to interact with the Firebase Database
// identified by the given URL.
func (a *App) DatabaseWithURL(ctx context.Context, url string) (*db.Client, error) {
conf := &internal.DatabaseConfig{
AuthOverride: a.authOverride,
URL: url,
Opts: a.opts,
Version: Version,
}
return db.NewClient(ctx, conf)
}
// Storage returns a new instance of storage.Client.
func (a *App) Storage(ctx context.Context) (*storage.Client, error) {
conf := &internal.StorageConfig{
Opts: a.opts,
Bucket: a.storageBucket,
}
return storage.NewClient(ctx, conf)
}
// Firestore returns a new firestore.Client instance from the https://godoc.org/cloud.google.com/go/firestore
// package.
func (a *App) Firestore(ctx context.Context) (*firestore.Client, error) {
if a.projectID == "" {
return nil, errors.New("project id is required to access Firestore")
}
return firestore.NewClient(ctx, a.projectID, a.opts...)
}
// InstanceID returns an instance of iid.Client.
func (a *App) InstanceID(ctx context.Context) (*iid.Client, error) {
conf := &internal.InstanceIDConfig{
ProjectID: a.projectID,
Opts: a.opts,
Version: Version,
}
return iid.NewClient(ctx, conf)
}
// Messaging returns an instance of messaging.Client.
func (a *App) Messaging(ctx context.Context) (*messaging.Client, error) {
conf := &internal.MessagingConfig{
ProjectID: a.projectID,
Opts: a.opts,
Version: Version,
}
return messaging.NewClient(ctx, conf)
}
// AppCheck returns an instance of appcheck.Client.
func (a *App) AppCheck(ctx context.Context) (*appcheck.Client, error) {
conf := &internal.AppCheckConfig{
ProjectID: a.projectID,
}
return appcheck.NewClient(ctx, conf)
}
// RemoteConfig returns an instance of remoteconfig.Client.
func (a *App) RemoteConfig(ctx context.Context) (*remoteconfig.Client, error) {
conf := &internal.RemoteConfigClientConfig{
ProjectID: a.projectID,
Opts: a.opts,
Version: Version,
}
return remoteconfig.NewClient(ctx, conf)
}
// NewApp creates a new App from the provided config and client options.
//
// If the client options contain a valid credential (a service account file, a refresh token
// file or an oauth2.TokenSource) the App will be authenticated using that credential. Otherwise,
// NewApp attempts to authenticate the App with Google application default credentials.
// If `config` is nil, the SDK will attempt to load the config options from the
// `FIREBASE_CONFIG` environment variable. If the value in it starts with a `{` it is parsed as a
// JSON object, otherwise it is assumed to be the name of the JSON file containing the options.
func NewApp(ctx context.Context, config *Config, opts ...option.ClientOption) (*App, error) {
o := []option.ClientOption{option.WithScopes(internal.FirebaseScopes...)}
o = append(o, opts...)
if config == nil {
var err error
if config, err = getConfigDefaults(); err != nil {
return nil, err
}
}
pid := getProjectID(ctx, config, o...)
ao := defaultAuthOverrides
if config.AuthOverride != nil {
ao = *config.AuthOverride
}
return &App{
authOverride: ao,
dbURL: config.DatabaseURL,
projectID: pid,
serviceAccountID: config.ServiceAccountID,
storageBucket: config.StorageBucket,
opts: o,
}, nil
}
// getConfigDefaults reads the default config file, defined by the FIREBASE_CONFIG
// env variable, used only when options are nil.
func getConfigDefaults() (*Config, error) {
fbc := &Config{}
confFileName := os.Getenv(firebaseEnvName)
if confFileName == "" {
return fbc, nil
}
var dat []byte
if confFileName[0] == byte('{') {
dat = []byte(confFileName)
} else {
var err error
if dat, err = ioutil.ReadFile(confFileName); err != nil {
return nil, err
}
}
if err := json.Unmarshal(dat, fbc); err != nil {
return nil, err
}
// Some special handling necessary for db auth overrides
var m map[string]interface{}
if err := json.Unmarshal(dat, &m); err != nil {
return nil, err
}
if ao, ok := m["databaseAuthVariableOverride"]; ok && ao == nil {
// Auth overrides are explicitly set to null
var nullMap map[string]interface{}
fbc.AuthOverride = &nullMap
}
return fbc, nil
}
func getProjectID(ctx context.Context, config *Config, opts ...option.ClientOption) string {
if config.ProjectID != "" {
return config.ProjectID
}
creds, _ := transport.Creds(ctx, opts...)
if creds != nil && creds.ProjectID != "" {
return creds.ProjectID
}
if pid := os.Getenv("GOOGLE_CLOUD_PROJECT"); pid != "" {
return pid
}
return os.Getenv("GCLOUD_PROJECT")
}
|