├── .circleci └── config.yml ├── .github └── renovate.json ├── .gitignore ├── .goreleaser.yml ├── LICENSE ├── Makefile ├── README.md ├── go.mod ├── go.sum └── main.go /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | jobs: 3 | build: # this check doesn't build the project because I don't have a macos plan on circleci 4 | docker: 5 | - image: circleci/golang:1.12 6 | working_directory: /go/src/github.com/moul.io/totp-keychain 7 | environment: 8 | GO111MODULE=on 9 | steps: 10 | - checkout 11 | - restore_cache: 12 | keys: 13 | - gopkg-{{ checksum "go.sum" }} 14 | - run: go mod download 15 | - run: gofmt -w -s . 16 | # here, should go 'go install', 'go test', etc; depends on macos plan 17 | - save_cache: 18 | key: v1-pkg-cache 19 | paths: 20 | - "/go/pkg" 21 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "config:base" 4 | ], 5 | "groupName": "all" 6 | } 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | # Binaries for programs and plugins 3 | *.exe 4 | *.exe~ 5 | *.dll 6 | *.so 7 | *.dylib 8 | 9 | # Test binary, build with `go test -c` 10 | *.test 11 | 12 | # Output of the go coverage tool, specifically when used with LiteIDE 13 | *.out 14 | -------------------------------------------------------------------------------- /.goreleaser.yml: -------------------------------------------------------------------------------- 1 | before: 2 | hooks: 3 | - go mod download 4 | builds: 5 | - 6 | goos: [darwin] 7 | goarch: [amd64] 8 | archives: 9 | - wrap_in_directory: true 10 | checksum: 11 | name_template: 'checksums.txt' 12 | snapshot: 13 | name_template: "{{ .Tag }}-next" 14 | changelog: 15 | sort: asc 16 | filters: 17 | exclude: 18 | - '^docs:' 19 | - '^test:' 20 | brew: 21 | name: totp-keychain 22 | github: 23 | owner: moul 24 | name: homebrew-moul 25 | commit_author: 26 | name: moul-bot 27 | email: "m+bot@42.am" 28 | homepage: https://manfred.life/cryptography 29 | description: TOTP cli backed by the OS X keychain 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: install 2 | install: 3 | go install 4 | 5 | .PHONY: release 6 | release: 7 | GITHUB_TOKEN=$(GORELEASER_GITHUB_TOKEN) goreleaser --rm-dist 8 | 9 | .PHONY: release-dry-run 10 | release-dry-run: 11 | goreleaser --snapshot --skip-publish --rm-dist 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # totp-keychain 2 | :lock: simple TOTP client backed by the keychain (OS X only) 3 | 4 | ## Usage 5 | 6 | ```console 7 | $ totp-keychain add moul@github JBSWY3DPEHPK3PXP 8 | 2019/06/06 17:59:17 OK 9 | 10 | $ totp-keychain add moul@cloudflare HXDMVJECJJWSRB3HWIZR4IFUGFTMXBOZ 11 | 2019/06/06 18:00:32 OK 12 | 13 | $ totp-keychain ls 14 | - moul@github 15 | - moul@cloudflare 16 | 17 | $ totp-keychain get moul@github 18 | 427530 19 | 20 | $ totp-keychain get moul@cloudflare 21 | 553053 22 | 23 | $ sleep 30 24 | 25 | $ totp-keychain get moul@github 26 | 600322 27 | 28 | $ totp-keychain get moul@cloudflare 29 | 007099 30 | ``` 31 | 32 | ## Install 33 | 34 | With Homebrew 35 | 36 | brew install moul/moul/totp-keychain 37 | 38 | With Golang 39 | 40 | ```console 41 | $ go get -u moul.io/totp-keychain 42 | go: finding moul.io/totp-keychain latest 43 | go: finding github.com/keybase/go-keychain latest 44 | go: finding github.com/boombuler/barcode v1.0.0 45 | go: finding github.com/stretchr/objx v0.2.0 46 | go: downloading moul.io/totp-keychain v0.0.0-20190606153853-716756d5e5e8 47 | go: extracting moul.io/totp-keychain v0.0.0-20190606153853-716756d5e5e8 48 | 49 | $ totp-keychain -h 50 | NAME: 51 | totp-keychain - A new cli application 52 | 53 | USAGE: 54 | totp-keychain [global options] command [command options] [arguments...] 55 | 56 | VERSION: 57 | 0.0.0 58 | 59 | COMMANDS: 60 | add 61 | rm 62 | ls 63 | get 64 | help, h Shows a list of commands or help for one command 65 | 66 | GLOBAL OPTIONS: 67 | --help, -h show help 68 | --version, -v print the version 69 | ``` 70 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module moul.io/totp-keychain 2 | 3 | go 1.12 4 | 5 | require ( 6 | github.com/keybase/go-keychain v0.0.0-20190604185112-cc436cc9fe98 7 | github.com/pquerna/otp v1.2.0 8 | github.com/urfave/cli v1.20.0 9 | ) 10 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc h1:biVzkmvwrH8WK8raXaxBx6fRVTlJILwEwQGL1I/ByEI= 2 | github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8= 3 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 4 | github.com/keybase/go-keychain v0.0.0-20190604185112-cc436cc9fe98 h1:CIcvKEAP7i7v/SWSwzAvq1ATWWs4+J/ezHqZT116+JA= 5 | github.com/keybase/go-keychain v0.0.0-20190604185112-cc436cc9fe98/go.mod h1:JJNrCn9otv/2QP4D7SMJBgaleKpOf66PnW6F5WGNRIc= 6 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 7 | github.com/pquerna/otp v1.2.0 h1:/A3+Jn+cagqayeR3iHs/L62m5ue7710D35zl1zJ1kok= 8 | github.com/pquerna/otp v1.2.0/go.mod h1:dkJfzwRKNiegxyNb54X/3fLwhCynbMspSyWKnvi1AEg= 9 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 10 | github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= 11 | github.com/urfave/cli v1.20.0 h1:fDqGv3UG/4jbVl/QkFwEdddtEDjh/5Ov6X+0B/3bPaw= 12 | github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA= 13 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main // import "moul.io/totp-keychain" 2 | 3 | import ( 4 | "errors" 5 | "fmt" 6 | "log" 7 | "os" 8 | "time" 9 | 10 | keychain "github.com/keybase/go-keychain" 11 | "github.com/pquerna/otp/totp" 12 | "github.com/urfave/cli" 13 | ) 14 | 15 | const ServiceName = "totp-keychain" 16 | 17 | func main() { 18 | app := cli.NewApp() 19 | app.Name = "totp-keychain" 20 | app.Commands = []cli.Command{ 21 | { 22 | Name: "add", 23 | Flags: []cli.Flag{ 24 | cli.StringFlag{ 25 | Name: "name, n", 26 | Usage: "Name of the account", 27 | }, 28 | cli.StringFlag{ 29 | Name: "secret, s", 30 | Usage: "TOTP Secret", 31 | }, 32 | }, 33 | Action: func(c *cli.Context) error { 34 | if c.NArg() < 2 { 35 | return errors.New("usage: add '' ''") 36 | } 37 | name := c.Args()[0] 38 | secret := c.Args()[1] 39 | item := keychain.NewItem() 40 | item.SetSecClass(keychain.SecClassGenericPassword) 41 | item.SetService(ServiceName) 42 | item.SetAccount(name) 43 | item.SetData([]byte(secret)) 44 | //item.SetSynchronizable(keychain.SynchronizableYes) 45 | item.SetAccessible(keychain.AccessibleWhenUnlocked) 46 | err := keychain.AddItem(item) 47 | if err == keychain.ErrorDuplicateItem { 48 | log.Println("Item already exists. To update it, remove it first and add it back.") 49 | return nil 50 | } 51 | log.Println("OK") 52 | return err 53 | }, 54 | }, 55 | { 56 | Name: "rm", 57 | Action: func(c *cli.Context) error { 58 | if c.NArg() < 1 { 59 | return errors.New("usage: rm ") 60 | } 61 | account := c.Args().First() 62 | item := keychain.NewItem() 63 | item.SetSecClass(keychain.SecClassGenericPassword) 64 | item.SetService(ServiceName) 65 | item.SetAccount(account) 66 | if err := keychain.DeleteItem(item); err != nil { 67 | return err 68 | } 69 | log.Println("OK") 70 | return nil 71 | }, 72 | }, 73 | { 74 | Name: "ls", 75 | Action: func(c *cli.Context) error { 76 | item := keychain.NewItem() 77 | item.SetSecClass(keychain.SecClassGenericPassword) 78 | item.SetService(ServiceName) 79 | item.SetMatchLimit(keychain.MatchLimitAll) 80 | item.SetReturnAttributes(true) 81 | results, err := keychain.QueryItem(item) 82 | if err != nil { 83 | return err 84 | } 85 | for _, r := range results { 86 | fmt.Printf("- %s\n", r.Account) 87 | } 88 | return nil 89 | }, 90 | }, 91 | { 92 | Name: "get", 93 | Action: func(c *cli.Context) error { 94 | if c.NArg() < 1 { 95 | return errors.New("usage: get ") 96 | } 97 | account := c.Args().First() 98 | query := keychain.NewItem() 99 | query.SetSecClass(keychain.SecClassGenericPassword) 100 | query.SetService(ServiceName) 101 | query.SetAccount(account) 102 | query.SetMatchLimit(keychain.MatchLimitOne) 103 | query.SetReturnData(true) 104 | results, err := keychain.QueryItem(query) 105 | if err != nil { 106 | return err 107 | } 108 | if len(results) < 1 { 109 | return errors.New("No such account with that name") 110 | } 111 | code, err := totp.GenerateCode(string(results[0].Data), time.Now()) 112 | if err != nil { 113 | return err 114 | } 115 | fmt.Println(code) 116 | return nil 117 | }, 118 | }, 119 | } 120 | 121 | if err := app.Run(os.Args); err != nil { 122 | log.Fatal(err) 123 | } 124 | } 125 | --------------------------------------------------------------------------------