From 9c81f9223faf5c4d5cd6292ae990f3d810534cf2 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Thu, 3 Aug 2017 14:13:53 +0200 Subject: [PATCH] Initial API Signed-off-by: Knut Ahlers --- .gitignore | 1 + CONTRIBUTING.md | 9 +++ LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++++++++ api.go | 82 +++++++++++++++++++ main.go | 53 +++++++++++++ storage.go | 24 ++++++ storage_mem.go | 30 +++++++ storage_redis.go | 54 +++++++++++++ 8 files changed, 455 insertions(+) create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 api.go create mode 100644 main.go create mode 100644 storage.go create mode 100644 storage_mem.go create mode 100644 storage_redis.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dafbf46 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +ots diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..59a90cd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing to this project + +Contributions are encouraged and welcome. Thank you very much for taking your time to contribute! + +## Code of Conduct +This project adheres to the [Contributor Covenant code of conduct](http://contributor-covenant.org/version/1/4/). By participating, you are expected to uphold this code. Please report unacceptable behavior to the [project maintainer](mailto:help@luzifer.io). + +## Developer Certificate of Origin +Please also review the [Developer Certificate of Origin](https://developercertificate.org/). All commits must be signed off using `git commit -s` to indicate you've read the document and your contribution meets the criteria defined in it. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8f71f43 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. + diff --git a/api.go b/api.go new file mode 100644 index 0000000..c3596ad --- /dev/null +++ b/api.go @@ -0,0 +1,82 @@ +package main + +import ( + "encoding/json" + "net/http" + + "github.com/gorilla/mux" +) + +type apiServer struct { + store storage +} + +func newAPI(s storage) *apiServer { + return &apiServer{ + store: s, + } +} + +func (a apiServer) Register(r *mux.Router) { + r.HandleFunc("/create", a.handleCreate) + r.HandleFunc("/get/{id}", a.handleRead) +} + +func (a apiServer) handleCreate(res http.ResponseWriter, r *http.Request) { + secret := r.FormValue("secret") + if secret == "" { + a.jsonResponse(res, http.StatusBadRequest, map[string]interface{}{ + "success": false, + "error": "Secret missing", + }) + return + } + + id, err := a.store.Create(secret) + if err != nil { + a.jsonResponse(res, http.StatusInternalServerError, map[string]interface{}{ + "success": false, + "error": err.Error(), + }) + return + } + + a.jsonResponse(res, http.StatusCreated, map[string]interface{}{ + "success": true, + "secret_id": id, + }) +} + +func (a apiServer) handleRead(res http.ResponseWriter, r *http.Request) { + vars := mux.Vars(r) + id := vars["id"] + if id == "" { + a.jsonResponse(res, http.StatusBadRequest, map[string]interface{}{ + "success": false, + "error": "ID missing", + }) + return + } + + secret, err := a.store.ReadAndDestroy(id) + if err != nil { + a.jsonResponse(res, http.StatusInternalServerError, map[string]interface{}{ + "success": false, + "error": err.Error(), + }) + return + } + + a.jsonResponse(res, http.StatusOK, map[string]interface{}{ + "success": true, + "secret": secret, + }) +} + +func (a apiServer) jsonResponse(res http.ResponseWriter, status int, response map[string]interface{}) { + res.Header().Set("Content-Type", "application/json") + res.Header().Set("Cache-Control", "no-cache") + res.WriteHeader(status) + + json.NewEncoder(res).Encode(response) +} diff --git a/main.go b/main.go new file mode 100644 index 0000000..227e1f0 --- /dev/null +++ b/main.go @@ -0,0 +1,53 @@ +package main + +import ( + "fmt" + "net/http" + "os" + + "github.com/Luzifer/rconfig" + "github.com/gorilla/mux" + log "github.com/sirupsen/logrus" +) + +var ( + cfg struct { + Listen string `flag:"listen" default:":3000" description:"IP/Port to listen on"` + LogLevel string `flag:"log-level" default:"info" description:"Set log level (debug, info, warning, error)"` + StorageType string `flag:"storage-type" default:"mem" description:"Storage to use for putting secrets to" validate:"nonzero"` + VersionAndExit bool `flag:"version" default:"false" description:"Print version information and exit"` + } + + product = "ots" + version = "dev" +) + +func init() { + if err := rconfig.ParseAndValidate(&cfg); err != nil { + log.Fatalf("Error parsing CLI arguments: %s", err) + } + + if l, err := log.ParseLevel(cfg.LogLevel); err == nil { + log.SetLevel(l) + } else { + log.Fatalf("Invalid log level: %s", err) + } + + if cfg.VersionAndExit { + fmt.Printf("%s %s\n", product, version) + os.Exit(0) + } +} + +func main() { + store, err := getStorageByType(cfg.StorageType) + if err != nil { + log.Fatalf("Could not initialize storage: %s", err) + } + api := newAPI(store) + + r := mux.NewRouter() + api.Register(r.PathPrefix("/api").Subrouter()) + + log.Fatalf("HTTP server quit: %s", http.ListenAndServe(cfg.Listen, r)) +} diff --git a/storage.go b/storage.go new file mode 100644 index 0000000..722b9a4 --- /dev/null +++ b/storage.go @@ -0,0 +1,24 @@ +package main + +import ( + "errors" + "fmt" +) + +var errSecretNotFound = errors.New("Secret not found") + +type storage interface { + Create(secret string) (string, error) + ReadAndDestroy(id string) (string, error) +} + +func getStorageByType(t string) (storage, error) { + switch t { + case "mem": + return newStorageMem(), nil + case "redis": + return newStorageRedis() + default: + return nil, fmt.Errorf("Storage type %q not found", t) + } +} diff --git a/storage_mem.go b/storage_mem.go new file mode 100644 index 0000000..b9477fd --- /dev/null +++ b/storage_mem.go @@ -0,0 +1,30 @@ +package main + +import "github.com/satori/uuid" + +type storageMem struct { + store map[string]string +} + +func newStorageMem() storage { + return &storageMem{ + store: make(map[string]string), + } +} + +func (s storageMem) Create(secret string) (string, error) { + id := uuid.NewV4().String() + s.store[id] = secret + + return id, nil +} + +func (s storageMem) ReadAndDestroy(id string) (string, error) { + secret, ok := s.store[id] + if !ok { + return "", errSecretNotFound + } + + delete(s.store, id) + return secret, nil +} diff --git a/storage_redis.go b/storage_redis.go new file mode 100644 index 0000000..4d2610e --- /dev/null +++ b/storage_redis.go @@ -0,0 +1,54 @@ +package main + +import ( + "fmt" + "os" + + "github.com/satori/uuid" + "github.com/xuyu/goredis" +) + +type storageRedis struct { + conn *goredis.Redis +} + +func newStorageRedis() (storage, error) { + if os.Getenv("REDIS_URL") == "" { + return nil, fmt.Errorf("REDIS_URL environment variable not set") + } + + c, err := goredis.DialURL(os.Getenv("REDIS_URL")) + if err != nil { + return nil, err + } + + return &storageRedis{ + conn: c, + }, nil +} + +func (s storageRedis) redisKey() string { + key := os.Getenv("REDIS_KEY") + if key == "" { + key = "io.luzifer.ots" + } + + return key +} + +func (s storageRedis) Create(secret string) (string, error) { + id := uuid.NewV4().String() + _, err := s.conn.HSet(s.redisKey(), id, secret) + + return id, err +} + +func (s storageRedis) ReadAndDestroy(id string) (string, error) { + secret, err := s.conn.HGet(s.redisKey(), id) + if err != nil { + return "", err + } + + _, err = s.conn.HDel(s.redisKey(), id) + return string(secret), err +}