├── CONTRIBUTING.md ├── LICENSE ├── README.md └── admin ├── .gitignore ├── main.go └── messaging.go /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | We'd love for you to contribute to our source code and to make it even better than it is today! Here are the guidelines we'd like you to follow: 4 | 5 | - [Code of Conduct](#coc) 6 | - [Question or Problem?](#question) 7 | - [Issues and Bugs](#issue) 8 | - [Feature Requests](#feature) 9 | - [Submission Guidelines](#submit) 10 | - [Coding Rules](#rules) 11 | - [Signing the CLA](#cla) 12 | 13 | ## Code of Conduct 14 | 15 | As contributors and maintainers of the project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities. 16 | 17 | Communication through any of Firebase's channels (GitHub, StackOverflow, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. 18 | 19 | We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same. 20 | 21 | If any member of the community violates this code of conduct, the maintainers of the project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate. 22 | 23 | If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at nivco@google.com. 24 | 25 | ## Got a Question or Problem? 26 | 27 | If you have questions about how to use the project, please direct these to [StackOverflow][stackoverflow] and use the `firebase` tag. We are also available on GitHub issues. 28 | 29 | If you feel that we're missing an important bit of documentation, feel free to 30 | file an issue so we can help. Here's an example to get you started: 31 | 32 | ``` 33 | What are you trying to do or find out more about? 34 | 35 | Where have you looked? 36 | 37 | Where did you expect to find this information? 38 | ``` 39 | 40 | ## Found an Issue? 41 | 42 | If you find a bug in the source code or a mistake in the documentation, you can help us by 43 | submitting an issue on this repository. Even better you can submit a Pull Request 44 | with a fix. 45 | 46 | See [below](#submit) for some guidelines. 47 | 48 | ## Submission Guidelines 49 | 50 | ### Submitting an Issue 51 | 52 | Before you submit your issue search the archive, maybe your question was already answered. 53 | 54 | If your issue appears to be a bug, and hasn't been reported, open a new issue. 55 | Help us to maximize the effort we can spend fixing issues and adding new 56 | features, by not reporting duplicate issues. Providing the following information will increase the 57 | chances of your issue being dealt with quickly: 58 | 59 | * **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps 60 | * **Motivation for or Use Case** - explain why this is a bug for you 61 | * **Browsers and Operating System** - is this a problem with all browsers or only IE9? 62 | * **Reproduce the Error** - provide a live example or an unambiguous set of steps. 63 | * **Related Issues** - has a similar issue been reported before? 64 | * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be 65 | causing the problem (line of code or commit) 66 | 67 | **If you get help, help others. Good karma rulez!** 68 | 69 | Here's a template to get you started: 70 | 71 | ``` 72 | System information (OS, Device, etc): 73 | 74 | What steps will reproduce the problem: 75 | 1. 76 | 2. 77 | 3. 78 | 79 | What is the expected result? 80 | 81 | What happens instead of that? 82 | 83 | Code, logs, or screenshot that illustrate the problem: 84 | ``` 85 | 86 | ### Submitting a Pull Request 87 | Before you submit your pull request consider the following guidelines: 88 | 89 | * Search for an open or closed Pull Request 90 | that relates to your submission. You don't want to duplicate effort. 91 | * Please sign our [Contributor License Agreement (CLA)](#cla) before 92 | sending pull requests. We cannot accept code without this. 93 | * Make your changes in a new git branch: 94 | 95 | ```shell 96 | git checkout -b my-fix-branch master 97 | ``` 98 | 99 | * Create your patch, **including appropriate test cases**. 100 | * Follow our [Coding Rules](#rules). 101 | * Commit your changes using a descriptive commit message. 102 | 103 | ```shell 104 | git commit -a 105 | ``` 106 | Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. 107 | 108 | * Build your changes locally to ensure all the tests pass: 109 | 110 | ```shell 111 | gulp 112 | ``` 113 | 114 | * Push your branch to GitHub: 115 | 116 | ```shell 117 | git push origin my-fix-branch 118 | ``` 119 | 120 | * In GitHub, send a pull request to `master`. 121 | * If we suggest changes then: 122 | * Make the required updates. 123 | * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): 124 | 125 | ```shell 126 | git rebase master -i 127 | git push origin my-fix-branch -f 128 | ``` 129 | 130 | That's it! Thank you for your contribution! 131 | 132 | #### After your pull request is merged 133 | 134 | After your pull request is merged, you can safely delete your branch and pull the changes 135 | from the main (upstream) repository: 136 | 137 | * Delete the remote branch on GitHub either through the GitHub UI or your local shell as follows: 138 | 139 | ```shell 140 | git push origin --delete my-fix-branch 141 | ``` 142 | 143 | * Check out the master branch: 144 | 145 | ```shell 146 | git checkout master -f 147 | ``` 148 | 149 | * Delete the local branch: 150 | 151 | ```shell 152 | git branch -D my-fix-branch 153 | ``` 154 | 155 | * Update your master with the latest upstream version: 156 | 157 | ```shell 158 | git pull --ff upstream master 159 | ``` 160 | 161 | ## Coding Rules 162 | 163 | We generally follow [Google's style guides][style-guide]. 164 | 165 | ## Signing the CLA 166 | 167 | Please sign our [Contributor License Agreement][google-cla] (CLA) before sending pull requests. For any code 168 | changes to be accepted, the CLA must be signed. It's a quick process, we promise! 169 | 170 | *This guide was inspired by the [AngularJS contribution guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md).* 171 | 172 | [google-cla]: https://cla.developers.google.com 173 | [style-guide]: http://google.github.io/styleguide/ 174 | [stackoverflow]: http://stackoverflow.com/questions/tagged/firebase -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2017 Google Inc 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | 204 | All code in any directories or sub-directories that end with *.html or 205 | *.css is licensed under the Creative Commons Attribution International 206 | 4.0 License, which full text can be found here: 207 | https://creativecommons.org/licenses/by/4.0/legalcode. 208 | 209 | As an exception to this license, all html or css that is generated by 210 | the software at the direction of the user is copyright the user. The 211 | user has full ownership and control over such content, including 212 | whether and how they wish to license it. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Firebase Go Snippets 2 | 3 | This repository holds code snippets used in Go documentation 4 | on [firebase.google.com](https://firebase.google.com/docs/). 5 | 6 | ## Contributing 7 | 8 | We love contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines. 9 | -------------------------------------------------------------------------------- /admin/.gitignore: -------------------------------------------------------------------------------- 1 | service-account.json 2 | -------------------------------------------------------------------------------- /admin/main.go: -------------------------------------------------------------------------------- 1 | // Copyright 2017 Google Inc. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | package main 16 | 17 | // [START admin_import] 18 | import ( 19 | "context" 20 | "log" 21 | 22 | firebase "firebase.google.com/go" 23 | "firebase.google.com/go/auth" 24 | 25 | "google.golang.org/api/iterator" 26 | "google.golang.org/api/option" 27 | ) 28 | 29 | // [END admin_import] 30 | 31 | // ================================================================== 32 | // https://firebase.google.com/docs/admin/setup 33 | // ================================================================== 34 | 35 | func initializeAppWithServiceAccount() *firebase.App { 36 | // [START initialize_app_service_account] 37 | opt := option.WithCredentialsFile("path/to/serviceAccountKey.json") 38 | app, err := firebase.NewApp(context.Background(), nil, opt) 39 | if err != nil { 40 | log.Fatalf("error initializing app: %v\n", err) 41 | } 42 | // [END initialize_app_service_account] 43 | 44 | return app 45 | } 46 | 47 | func initializeAppWithRefreshToken() *firebase.App { 48 | // [START initialize_app_refresh_token] 49 | opt := option.WithCredentialsFile("path/to/refreshToken.json") 50 | config := &firebase.Config{ProjectID: "my-project-id"} 51 | app, err := firebase.NewApp(context.Background(), config, opt) 52 | if err != nil { 53 | log.Fatalf("error initializing app: %v\n", err) 54 | } 55 | // [END initialize_app_refresh_token] 56 | 57 | return app 58 | } 59 | 60 | func initializeAppDefault() *firebase.App { 61 | // [START initialize_app_default] 62 | app, err := firebase.NewApp(context.Background(), nil) 63 | if err != nil { 64 | log.Fatalf("error initializing app: %v\n", err) 65 | } 66 | // [END initialize_app_default] 67 | 68 | return app 69 | } 70 | 71 | func accessServicesSingleApp() (*auth.Client, error) { 72 | // [START access_services_single_app] 73 | // Initialize default app 74 | app, err := firebase.NewApp(context.Background(), nil) 75 | if err != nil { 76 | log.Fatalf("error initializing app: %v\n", err) 77 | } 78 | 79 | // Access auth service from the default app 80 | client, err := app.Auth(context.Background()) 81 | if err != nil { 82 | log.Fatalf("error getting Auth client: %v\n", err) 83 | } 84 | // [END access_services_single_app] 85 | 86 | return client, err 87 | } 88 | 89 | func accessServicesMultipleApp() (*auth.Client, error) { 90 | // [START access_services_multiple_app] 91 | // Initialize the default app 92 | defaultApp, err := firebase.NewApp(context.Background(), nil) 93 | if err != nil { 94 | log.Fatalf("error initializing app: %v\n", err) 95 | } 96 | 97 | // Initialize another app with a different config 98 | opt := option.WithCredentialsFile("service-account-other.json") 99 | otherApp, err := firebase.NewApp(context.Background(), nil, opt) 100 | if err != nil { 101 | log.Fatalf("error initializing app: %v\n", err) 102 | } 103 | 104 | // Access Auth service from default app 105 | defaultClient, err := defaultApp.Auth(context.Background()) 106 | if err != nil { 107 | log.Fatalf("error getting Auth client: %v\n", err) 108 | } 109 | 110 | // Access auth service from other app 111 | otherClient, err := otherApp.Auth(context.Background()) 112 | if err != nil { 113 | log.Fatalf("error getting Auth client: %v\n", err) 114 | } 115 | // [END access_services_multiple_app] 116 | // Avoid unused 117 | _ = defaultClient 118 | return otherClient, nil 119 | } 120 | 121 | // ================================================================== 122 | // https://firebase.google.com/docs/auth/admin/create-custom-tokens 123 | // ================================================================== 124 | 125 | func createCustomToken(app *firebase.App) string { 126 | // [START create_custom_token] 127 | client, err := app.Auth(context.Background()) 128 | if err != nil { 129 | log.Fatalf("error getting Auth client: %v\n", err) 130 | } 131 | 132 | token, err := client.CustomToken("some-uid") 133 | if err != nil { 134 | log.Fatalf("error minting custom token: %v\n", err) 135 | } 136 | 137 | log.Printf("Got custom token: %v\n", token) 138 | // [END create_custom_token] 139 | 140 | return token 141 | } 142 | 143 | func createCustomTokenWithClaims(app *firebase.App) string { 144 | // [START create_custom_token_claims] 145 | client, err := app.Auth(context.Background()) 146 | if err != nil { 147 | log.Fatalf("error getting Auth client: %v\n", err) 148 | } 149 | 150 | claims := map[string]interface{}{ 151 | "premiumAccount": true, 152 | } 153 | 154 | token, err := client.CustomTokenWithClaims("some-uid", claims) 155 | if err != nil { 156 | log.Fatalf("error minting custom token: %v\n", err) 157 | } 158 | 159 | log.Printf("Got custom token: %v\n", token) 160 | // [END create_custom_token_claims] 161 | 162 | return token 163 | } 164 | 165 | // ================================================================== 166 | // https://firebase.google.com/docs/auth/admin/verify-id-tokens 167 | // ================================================================== 168 | 169 | func verifyIDToken(app *firebase.App, idToken string) *auth.Token { 170 | // [START verify_id_token] 171 | client, err := app.Auth(context.Background()) 172 | if err != nil { 173 | log.Fatalf("error getting Auth client: %v\n", err) 174 | } 175 | 176 | token, err := client.VerifyIDToken(idToken) 177 | if err != nil { 178 | log.Fatalf("error verifying ID token: %v\n", err) 179 | } 180 | 181 | log.Printf("Verified ID token: %v\n", token) 182 | // [END verify_id_token] 183 | 184 | return token 185 | } 186 | 187 | // ================================================================== 188 | // https://firebase.google.com/docs/auth/admin/manage-sessions 189 | // ================================================================== 190 | 191 | func revokeRefreshTokens(app *firebase.App, uid string) { 192 | 193 | // [START revoke_tokens] 194 | ctx := context.Background() 195 | client, err := app.Auth(ctx) 196 | if err != nil { 197 | log.Fatalf("error getting Auth client: %v\n", err) 198 | } 199 | if err := client.RevokeRefreshTokens(ctx, uid); err != nil { 200 | log.Fatalf("error revoking tokens for user: %v, %v\n", uid, err) 201 | } 202 | // accessing the user's TokenValidAfter 203 | u, err := client.GetUser(ctx, uid) 204 | if err != nil { 205 | log.Fatalf("error getting user %s: %v\n", uid, err) 206 | } 207 | timestamp := u.TokensValidAfterMillis / 1000 208 | log.Printf("the refresh tokens were revoked at: %d (UTC seconds) ", timestamp) 209 | // [END revoke_tokens] 210 | } 211 | 212 | func verifyIDTokenAndCheckRevoked(app *firebase.App, idToken string) *auth.Token { 213 | ctx := context.Background() 214 | // [START verify_id_token_and_check_revoked] 215 | client, err := app.Auth(ctx) 216 | if err != nil { 217 | log.Fatalf("error getting Auth client: %v\n", err) 218 | } 219 | token, err := client.VerifyIDTokenAndCheckRevoked(ctx, idToken) 220 | if err != nil { 221 | if err.Error() == "ID token has been revoked" { 222 | // Token is revoked. Inform the user to reauthenticate or signOut() the user. 223 | } else { 224 | // Token is invalid 225 | } 226 | } 227 | log.Printf("Verified ID token: %v\n", token) 228 | // [END verify_id_token_and_check_revoked] 229 | 230 | return token 231 | } 232 | 233 | // ================================================================== 234 | // https://firebase.google.com/docs/auth/admin/manage-users 235 | // ================================================================== 236 | 237 | func getUser(ctx context.Context, app *firebase.App) *auth.UserRecord { 238 | uid := "some_string_uid" 239 | 240 | // [START get_user] 241 | // Get an auth client from the firebase.App 242 | client, err := app.Auth(context.Background()) 243 | if err != nil { 244 | log.Fatalf("error getting Auth client: %v\n", err) 245 | } 246 | 247 | u, err := client.GetUser(ctx, uid) 248 | if err != nil { 249 | log.Fatalf("error getting user %s: %v\n", uid, err) 250 | } 251 | log.Printf("Successfully fetched user data: %v\n", u) 252 | // [END get_user] 253 | return u 254 | } 255 | 256 | func getUserByEmail(ctx context.Context, client *auth.Client) *auth.UserRecord { 257 | email := "some@email.com" 258 | // [START get_user_by_email] 259 | u, err := client.GetUserByEmail(ctx, email) 260 | if err != nil { 261 | log.Fatalf("error getting user by email %s: %v\n", email, err) 262 | } 263 | log.Printf("Successfully fetched user data: %v\n", u) 264 | // [END get_user_by_email] 265 | return u 266 | } 267 | 268 | func getUserByPhone(ctx context.Context, client *auth.Client) *auth.UserRecord { 269 | phone := "+13214567890" 270 | // [START get_user_by_phone] 271 | u, err := client.GetUserByPhoneNumber(ctx, phone) 272 | if err != nil { 273 | log.Fatalf("error getting user by phone %s: %v\n", phone, err) 274 | } 275 | log.Printf("Successfully fetched user data: %v\n", u) 276 | // [END get_user_by_phone] 277 | return u 278 | } 279 | 280 | func createUser(ctx context.Context, client *auth.Client) *auth.UserRecord { 281 | // [START create_user] 282 | params := (&auth.UserToCreate{}). 283 | Email("user@example.com"). 284 | EmailVerified(false). 285 | PhoneNumber("+15555550100"). 286 | Password("secretPassword"). 287 | DisplayName("John Doe"). 288 | PhotoURL("http://www.example.com/12345678/photo.png"). 289 | Disabled(false) 290 | u, err := client.CreateUser(context.Background(), params) 291 | if err != nil { 292 | log.Fatalf("error creating user: %v\n", err) 293 | } 294 | log.Printf("Successfully created user: %v\n", u) 295 | // [END create_user] 296 | return u 297 | } 298 | 299 | func createUserWithUID(ctx context.Context, client *auth.Client) *auth.UserRecord { 300 | uid := "something" 301 | // [START create_user_with_uid] 302 | params := (&auth.UserToCreate{}). 303 | UID(uid). 304 | Email("user@example.com"). 305 | PhoneNumber("+15555550100") 306 | u, err := client.CreateUser(context.Background(), params) 307 | if err != nil { 308 | log.Fatalf("error creating user: %v\n", err) 309 | } 310 | log.Printf("Successfully created user: %v\n", u) 311 | // [END create_user_with_uid] 312 | return u 313 | } 314 | 315 | func updateUser(ctx context.Context, client *auth.Client) { 316 | uid := "d" 317 | // [START update_user] 318 | params := (&auth.UserToUpdate{}). 319 | Email("user@example.com"). 320 | EmailVerified(true). 321 | PhoneNumber("+15555550100"). 322 | Password("newPassword"). 323 | DisplayName("John Doe"). 324 | PhotoURL("http://www.example.com/12345678/photo.png"). 325 | Disabled(true) 326 | u, err := client.UpdateUser(context.Background(), uid, params) 327 | if err != nil { 328 | log.Fatalf("error updating user: %v\n", err) 329 | } 330 | log.Printf("Successfully updated user: %v\n", u) 331 | // [END update_user] 332 | } 333 | 334 | func deleteUser(ctx context.Context, client *auth.Client) { 335 | uid := "d" 336 | // [START delete_user] 337 | err := client.DeleteUser(context.Background(), uid) 338 | if err != nil { 339 | log.Fatalf("error deleting user: %v\n", err) 340 | } 341 | log.Printf("Successfully deleted user: %s\n", uid) 342 | // [END delete_user] 343 | } 344 | 345 | func customClaimsSet(ctx context.Context, app *firebase.App) { 346 | uid := "uid" 347 | // [START set_custom_user_claims] 348 | // Get an auth client from the firebase.App 349 | client, err := app.Auth(context.Background()) 350 | if err != nil { 351 | log.Fatalf("error getting Auth client: %v\n", err) 352 | } 353 | 354 | // Set admin privilege on the user corresponding to uid. 355 | claims := map[string]interface{}{"admin": true} 356 | err = client.SetCustomUserClaims(context.Background(), uid, claims) 357 | if err != nil { 358 | log.Fatalf("error setting custom claims %v\n", err) 359 | } 360 | // The new custom claims will propagate to the user's ID token the 361 | // next time a new one is issued. 362 | // [END set_custom_user_claims] 363 | // erase all existing custom claims 364 | } 365 | 366 | func customClaimsVerify(ctx context.Context, client *auth.Client) { 367 | idToken := "token" 368 | // [START verify_custom_claims] 369 | // Verify the ID token first. 370 | token, err := client.VerifyIDToken(idToken) 371 | if err != nil { 372 | log.Fatal(err) 373 | } 374 | 375 | claims := token.Claims 376 | if admin, ok := claims["admin"]; ok { 377 | if admin.(bool) { 378 | //Allow access to requested admin resource. 379 | } 380 | } 381 | // [END verify_custom_claims] 382 | } 383 | 384 | func customClaimsRead(ctx context.Context, client *auth.Client) { 385 | uid := "uid" 386 | // [START read_custom_user_claims] 387 | // Lookup the user associated with the specified uid. 388 | user, err := client.GetUser(ctx, uid) 389 | if err != nil { 390 | log.Fatal(err) 391 | } 392 | // The claims can be accessed on the user record. 393 | if admin, ok := user.CustomClaims["admin"]; ok { 394 | if admin.(bool) { 395 | log.Println(admin) 396 | } 397 | } 398 | // [END read_custom_user_claims] 399 | } 400 | 401 | func customClaimsScript(ctx context.Context, client *auth.Client) { 402 | // [START set_custom_user_claims_script] 403 | user, err := client.GetUserByEmail(ctx, "user@admin.example.com") 404 | if err != nil { 405 | log.Fatal(err) 406 | } 407 | // Confirm user is verified 408 | if user.EmailVerified { 409 | // Add custom claims for additional privileges. 410 | // This will be picked up by the user on token refresh or next sign in on new device. 411 | err := client.SetCustomUserClaims(ctx, user.UID, map[string]interface{}{"admin": true}) 412 | if err != nil { 413 | log.Fatalf("error setting custom claims %v\n", err) 414 | } 415 | 416 | } 417 | // [END set_custom_user_claims_script] 418 | } 419 | 420 | func customClaimsIncremental(ctx context.Context, client *auth.Client) { 421 | // [START set_custom_user_claims_incremental] 422 | user, err := client.GetUserByEmail(ctx, "user@admin.example.com") 423 | if err != nil { 424 | log.Fatal(err) 425 | } 426 | // Add incremental custom claim without overwriting existing claims. 427 | currentCustomClaims := user.CustomClaims 428 | if currentCustomClaims == nil { 429 | currentCustomClaims = map[string]interface{}{} 430 | } 431 | 432 | if _, found := currentCustomClaims["admin"]; found { 433 | // Add level. 434 | currentCustomClaims["accessLevel"] = 10 435 | // Add custom claims for additional privileges. 436 | err := client.SetCustomUserClaims(ctx, user.UID, currentCustomClaims) 437 | if err != nil { 438 | log.Fatalf("error setting custom claims %v\n", err) 439 | } 440 | 441 | } 442 | // [END set_custom_user_claims_incremental] 443 | } 444 | 445 | func listUsers(ctx context.Context, client *auth.Client) { 446 | // [START list_all_users] 447 | // Note, behind the scenes, the Users() iterator will retrive 1000 Users at a time through the API 448 | iter := client.Users(context.Background(), "") 449 | for { 450 | user, err := iter.Next() 451 | if err == iterator.Done { 452 | break 453 | } 454 | if err != nil { 455 | log.Fatalf("error listing users: %s\n", err) 456 | } 457 | log.Printf("read user user: %v\n", user) 458 | } 459 | 460 | // Iterating by pages 100 users at a time. 461 | // Note that using both the Next() function on an iterator and the NextPage() 462 | // on a Pager wrapping that same iterator will result in an error. 463 | pager := iterator.NewPager(client.Users(context.Background(), ""), 100, "") 464 | for { 465 | var users []*auth.ExportedUserRecord 466 | nextPageToken, err := pager.NextPage(&users) 467 | if err != nil { 468 | log.Fatalf("paging error %v\n", err) 469 | } 470 | for _, u := range users { 471 | log.Printf("read user user: %v\n", u) 472 | } 473 | if nextPageToken == "" { 474 | break 475 | } 476 | } 477 | // [END list_all_users] 478 | } 479 | 480 | // ================================================================== 481 | // https://firebase.google.com/docs/storage/admin/start 482 | // ================================================================== 483 | 484 | func cloudStorage() { 485 | // [START cloud_storage] 486 | config := &firebase.Config{ 487 | StorageBucket: ".appspot.com", 488 | } 489 | opt := option.WithCredentialsFile("path/to/serviceAccountKey.json") 490 | app, err := firebase.NewApp(context.Background(), config, opt) 491 | if err != nil { 492 | log.Fatalln(err) 493 | } 494 | 495 | client, err := app.Storage(context.Background()) 496 | if err != nil { 497 | log.Fatalln(err) 498 | } 499 | 500 | bucket, err := client.DefaultBucket() 501 | if err != nil { 502 | log.Fatalln(err) 503 | } 504 | // 'bucket' is an object defined in the cloud.google.com/go/storage package. 505 | // See https://godoc.org/cloud.google.com/go/storage#BucketHandle 506 | // for more details. 507 | // [END cloud_storage] 508 | 509 | log.Printf("Created bucket handle: %v\n", bucket) 510 | } 511 | 512 | func cloudStorageCustomBucket(app *firebase.App) { 513 | client, err := app.Storage(context.Background()) 514 | if err != nil { 515 | log.Fatalln(err) 516 | } 517 | 518 | // [START cloud_storage_custom_bucket] 519 | bucket, err := client.Bucket("my-custom-bucket") 520 | // [END cloud_storage_custom_bucket] 521 | if err != nil { 522 | log.Fatalln(err) 523 | } 524 | log.Printf("Created bucket handle: %v\n", bucket) 525 | } 526 | 527 | func main() { 528 | app := initializeAppWithServiceAccount() 529 | 530 | _ = createCustomToken(app) 531 | _ = createCustomTokenWithClaims(app) 532 | _ = verifyIDToken(app, "some-token") 533 | cloudStorage() 534 | cloudStorageCustomBucket(app) 535 | } 536 | -------------------------------------------------------------------------------- /admin/messaging.go: -------------------------------------------------------------------------------- 1 | // Copyright 2018 Google Inc. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | package main 16 | 17 | import ( 18 | "fmt" 19 | "log" 20 | "time" 21 | 22 | "firebase.google.com/go" 23 | "firebase.google.com/go/messaging" 24 | "golang.org/x/net/context" 25 | ) 26 | 27 | func sendToToken(app *firebase.App) { 28 | // [START send_to_token] 29 | // Obtain a messaging.Client from the App. 30 | ctx := context.Background() 31 | client, err := app.Messaging(ctx) 32 | 33 | // This registration token comes from the client FCM SDKs. 34 | registrationToken := "YOUR_REGISTRATION_TOKEN" 35 | 36 | // See documentation on defining a message payload. 37 | message := &messaging.Message{ 38 | Data: map[string]string{ 39 | "score": "850", 40 | "time": "2:45", 41 | }, 42 | Token: registrationToken, 43 | } 44 | 45 | // Send a message to the device corresponding to the provided 46 | // registration token. 47 | response, err := client.Send(ctx, message) 48 | if err != nil { 49 | log.Fatalln(err) 50 | } 51 | // Response is a message ID string. 52 | fmt.Println("Successfully sent message:", response) 53 | // [END send_to_token] 54 | } 55 | 56 | func sendToTopic(ctx context.Context, client *messaging.Client) { 57 | // [START send_to_topic] 58 | // The topic name can be optionally prefixed with "/topics/". 59 | topic := "highScores" 60 | 61 | // See documentation on defining a message payload. 62 | message := &messaging.Message{ 63 | Data: map[string]string{ 64 | "score": "850", 65 | "time": "2:45", 66 | }, 67 | Topic: topic, 68 | } 69 | 70 | // Send a message to the devices subscribed to the provided topic. 71 | response, err := client.Send(ctx, message) 72 | if err != nil { 73 | log.Fatalln(err) 74 | } 75 | // Response is a message ID string. 76 | fmt.Println("Successfully sent message:", response) 77 | // [END send_to_topic] 78 | } 79 | 80 | func sendToCondition(ctx context.Context, client *messaging.Client) { 81 | // [START send_to_condition] 82 | // Define a condition which will send to devices which are subscribed 83 | // to either the Google stock or the tech industry topics. 84 | condition := "'stock-GOOG' in topics || 'industry-tech' in topics" 85 | 86 | // See documentation on defining a message payload. 87 | message := &messaging.Message{ 88 | Data: map[string]string{ 89 | "score": "850", 90 | "time": "2:45", 91 | }, 92 | Condition: condition, 93 | } 94 | 95 | // Send a message to devices subscribed to the combination of topics 96 | // specified by the provided condition. 97 | response, err := client.Send(ctx, message) 98 | if err != nil { 99 | log.Fatalln(err) 100 | } 101 | // Response is a message ID string. 102 | fmt.Println("Successfully sent message:", response) 103 | // [END send_to_condition] 104 | } 105 | 106 | func sendDryRun(ctx context.Context, client *messaging.Client) { 107 | message := &messaging.Message{ 108 | Data: map[string]string{ 109 | "score": "850", 110 | "time": "2:45", 111 | }, 112 | Token: "token", 113 | } 114 | 115 | // [START send_dry_run] 116 | // Send a message in the dry run mode. 117 | response, err := client.SendDryRun(ctx, message) 118 | if err != nil { 119 | log.Fatalln(err) 120 | } 121 | // Response is a message ID string. 122 | fmt.Println("Dry run successful:", response) 123 | // [END send_dry_run] 124 | } 125 | 126 | func androidMessage() *messaging.Message { 127 | // [START android_message] 128 | oneHour := time.Duration(1) * time.Hour 129 | message := &messaging.Message{ 130 | Android: &messaging.AndroidConfig{ 131 | TTL: &oneHour, 132 | Priority: "normal", 133 | Notification: &messaging.AndroidNotification{ 134 | Title: "$GOOG up 1.43% on the day", 135 | Body: "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.", 136 | Icon: "stock_ticker_update", 137 | Color: "#f45342", 138 | }, 139 | }, 140 | Topic: "industry-tech", 141 | } 142 | // [END android_message] 143 | return message 144 | } 145 | 146 | func apnsMessage() *messaging.Message { 147 | // [START apns_message] 148 | badge := 42 149 | message := &messaging.Message{ 150 | APNS: &messaging.APNSConfig{ 151 | Headers: map[string]string{ 152 | "apns-priority": "10", 153 | }, 154 | Payload: &messaging.APNSPayload{ 155 | Aps: &messaging.Aps{ 156 | Alert: &messaging.ApsAlert{ 157 | Title: "$GOOG up 1.43% on the day", 158 | Body: "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.", 159 | }, 160 | Badge: &badge, 161 | }, 162 | }, 163 | }, 164 | Topic: "industry-tech", 165 | } 166 | // [END apns_message] 167 | return message 168 | } 169 | 170 | func webpushMessage() *messaging.Message { 171 | // [START webpush_message] 172 | message := &messaging.Message{ 173 | Webpush: &messaging.WebpushConfig{ 174 | Notification: &messaging.WebpushNotification{ 175 | Title: "$GOOG up 1.43% on the day", 176 | Body: "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.", 177 | Icon: "https://my-server/icon.png", 178 | }, 179 | }, 180 | Topic: "industry-tech", 181 | } 182 | // [END webpush_message] 183 | return message 184 | } 185 | 186 | func allPlatformsMessage() *messaging.Message { 187 | // [START multi_platforms_message] 188 | oneHour := time.Duration(1) * time.Hour 189 | badge := 42 190 | message := &messaging.Message{ 191 | Notification: &messaging.Notification{ 192 | Title: "$GOOG up 1.43% on the day", 193 | Body: "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.", 194 | }, 195 | Android: &messaging.AndroidConfig{ 196 | TTL: &oneHour, 197 | Notification: &messaging.AndroidNotification{ 198 | Icon: "stock_ticker_update", 199 | Color: "#f45342", 200 | }, 201 | }, 202 | APNS: &messaging.APNSConfig{ 203 | Payload: &messaging.APNSPayload{ 204 | Aps: &messaging.Aps{ 205 | Badge: &badge, 206 | }, 207 | }, 208 | }, 209 | Topic: "industry-tech", 210 | } 211 | // [END multi_platforms_message] 212 | return message 213 | } 214 | 215 | func subscribeToTopic(ctx context.Context, client *messaging.Client) { 216 | topic := "highScores" 217 | 218 | // [START subscribe] 219 | // These registration tokens come from the client FCM SDKs. 220 | registrationTokens := []string{ 221 | "YOUR_REGISTRATION_TOKEN_1", 222 | // ... 223 | "YOUR_REGISTRATION_TOKEN_n", 224 | } 225 | 226 | // Subscribe the devices corresponding to the registration tokens to the 227 | // topic. 228 | response, err := client.SubscribeToTopic(ctx, registrationTokens, topic) 229 | if err != nil { 230 | log.Fatalln(err) 231 | } 232 | // See the TopicManagementResponse reference documentation 233 | // for the contents of response. 234 | fmt.Println(response.SuccessCount, "tokens were subscribed successfully") 235 | // [END subscribe] 236 | } 237 | 238 | func unsubscribeFromTopic(ctx context.Context, client *messaging.Client) { 239 | topic := "highScores" 240 | 241 | // [START unsubscribe] 242 | // These registration tokens come from the client FCM SDKs. 243 | registrationTokens := []string{ 244 | "YOUR_REGISTRATION_TOKEN_1", 245 | // ... 246 | "YOUR_REGISTRATION_TOKEN_n", 247 | } 248 | 249 | // Unsubscribe the devices corresponding to the registration tokens from 250 | // the topic. 251 | response, err := client.UnsubscribeFromTopic(ctx, registrationTokens, topic) 252 | if err != nil { 253 | log.Fatalln(err) 254 | } 255 | // See the TopicManagementResponse reference documentation 256 | // for the contents of response. 257 | fmt.Println(response.SuccessCount, "tokens were unsubscribed successfully") 258 | // [END unsubscribe] 259 | } 260 | --------------------------------------------------------------------------------