diff --git a/.env.sample b/.env.sample index fe1a9f8f7..f8fd70de1 100644 --- a/.env.sample +++ b/.env.sample @@ -34,3 +34,6 @@ SMTP_HOST=localhost:1025 SMTP_USER= SMTP_PASS= SMTP_FROM="Crust" + +SUBSCRIPTION_KEY=E7ox7cDMmBzsFS15Ub43KKdbBg6gqOYiUhK3nRN0BlpNzt88mHLycahhVfrJCccc +SUBSCRIPTION_DOMAIN=local.crust.tech diff --git a/Gopkg.lock b/Gopkg.lock index e43565439..2649d843b 100644 --- a/Gopkg.lock +++ b/Gopkg.lock @@ -44,6 +44,14 @@ pruneopts = "UT" revision = "982855dad3e1cd68828d2106997539f36fcf6601" +[[projects]] + branch = "master" + digest = "1:b2d8bf10f6279453f6771158d7afcbb2e047714f7d2e2204f2ea9d630d90d4f2" + name = "github.com/crusttech/permit" + packages = ["pkg/permit"] + pruneopts = "UT" + revision = "6c0c4bece8da7f75a52930f3c07d01a5406499bb" + [[projects]] digest = "1:ffe9824d294da03b391f44e1ae8281281b4afc1bdaa9588c9097785e3af10cec" name = "github.com/davecgh/go-spew" @@ -512,6 +520,7 @@ "github.com/SentimensRG/ctx", "github.com/SentimensRG/ctx/sigctx", "github.com/crusttech/go-oidc", + "github.com/crusttech/permit/pkg/permit", "github.com/davecgh/go-spew/spew", "github.com/dgrijalva/jwt-go", "github.com/disintegration/imaging", @@ -528,6 +537,7 @@ "github.com/jmoiron/sqlx/types", "github.com/joho/godotenv", "github.com/joho/godotenv/autoload", + "github.com/lann/builder", "github.com/markbates/goth", "github.com/markbates/goth/gothic", "github.com/markbates/goth/providers/facebook", diff --git a/cmd/system-cli/main.go b/cmd/system-cli/main.go index cec052b8b..973ee89d4 100644 --- a/cmd/system-cli/main.go +++ b/cmd/system-cli/main.go @@ -23,7 +23,6 @@ func main() { var commands []string if len(os.Args) > 0 { - // @todo migrate to a proper solution (eg: https://github.com/spf13/cobra) commands = os.Args[1:] for a, arg := range os.Args { diff --git a/cmd/system/main.go b/cmd/system/main.go index 6f4d430a6..2b66e5ca7 100644 --- a/cmd/system/main.go +++ b/cmd/system/main.go @@ -4,6 +4,10 @@ import ( "log" "os" + context "github.com/SentimensRG/ctx" + "github.com/SentimensRG/ctx/sigctx" + + "github.com/crusttech/crust/internal/subscription" service "github.com/crusttech/crust/system" "github.com/crusttech/crust/internal/auth" @@ -11,7 +15,15 @@ import ( ) func main() { - flags("system", service.Flags, auth.Flags, rbac.Flags) + ctx := context.AsContext(sigctx.New()) + + flags( + "system", + service.Flags, + auth.Flags, + rbac.Flags, + subscription.Flags, + ) // log to stdout not stderr log.SetOutput(os.Stdout) @@ -30,7 +42,16 @@ func main() { case "help": case "merge-users": default: - if err := service.Start(); err != nil { + log.Println("Validating subscription") + // Checks subscription & runs internal checker that runs every 24h + if err := subscription.Check(ctx); err != nil { + log.Printf("Subscription could not be validated, reason: %v", err) + os.Exit(-1) + } else { + log.Println("Subscription valdiated") + } + + if err := service.StartRestAPI(ctx); err != nil { log.Fatalf("Error starting/running: %+v", err) } } diff --git a/internal/config/subscription.go b/internal/config/subscription.go new file mode 100644 index 000000000..8f248a107 --- /dev/null +++ b/internal/config/subscription.go @@ -0,0 +1,33 @@ +package config + +import ( + "github.com/namsral/flag" +) + +type ( + Subscription struct { + Key string + Domain string + } +) + +var subscription *Subscription + +func (c *Subscription) Validate() error { + if c == nil { + return nil + } + + return nil +} + +func (*Subscription) Init(prefix ...string) *Subscription { + if subscription != nil { + return subscription + } + + subscription = new(Subscription) + flag.StringVar(&subscription.Key, "subscription-key", "", "Subscription key") + flag.StringVar(&subscription.Domain, "subscription-domain", "", "Domain") + return subscription +} diff --git a/internal/subscription/check.go b/internal/subscription/check.go new file mode 100644 index 000000000..20a78f91a --- /dev/null +++ b/internal/subscription/check.go @@ -0,0 +1,52 @@ +package subscription + +import ( + "context" + + "github.com/pkg/errors" + + "github.com/crusttech/permit/pkg/permit" +) + +// Check for subscription +func Check(ctx context.Context) error { + p := permit.Permit{ + Key: flags.subscription.Key, + Domain: flags.subscription.Domain, + } + + // Do not collect stats on local domains. + // if p.Domain != "local.crust.tech" { + // @todo collect & pass attributes (no of users....) to be validated by permit.crust.tech subscription server. + p.Attributes = map[string]int{ + "messaging.enabled": 1, + // "messaging.max-public-channels": 1, + // "messaging.max-messages": 1, + // "messaging.max-users": 1, + // "messaging.max-private-channels": 1, + + "system.enabled": 1, + // "system.max-organisations": 1, + // "system.max-users": 1, + // "system.max-teams": 1, + + "compose.enabled": 1, + // "compose.max-modules": 1, + // "compose.max-pages": 1, + // "compose.max-triggers": 1, + // "compose.max-users": 1, + // "compose.max-namespaces": 1, + // "compose.max-charts": 1, + } + // } + + if p, err := permit.Check(ctx, p); err != nil { + return errors.Wrap(err, "unable to check for licence") + } else if !p.IsValid() { + return err + } else if p.Domain != flags.subscription.Domain { + return errors.Errorf("subscription domains do not match (%s <> %s)", p.Domain, flags.subscription.Domain) + } + + return nil +} diff --git a/internal/subscription/flags.go b/internal/subscription/flags.go new file mode 100644 index 000000000..02e2283fb --- /dev/null +++ b/internal/subscription/flags.go @@ -0,0 +1,35 @@ +package subscription + +import ( + "github.com/crusttech/crust/internal/config" +) + +type ( + localFlags struct { + subscription *config.Subscription + } +) + +var flags *localFlags + +// Flags matches signature for main() +func Flags(prefix ...string) { + new(localFlags).Init(prefix...) +} + +func (f *localFlags) Validate() error { + if err := f.subscription.Validate(); err != nil { + return err + } + return nil +} + +func (f *localFlags) Init(prefix ...string) *localFlags { + if flags != nil { + return flags + } + flags = &localFlags{ + new(config.Subscription).Init(prefix...), + } + return flags +} diff --git a/system/start.go b/system/start.go index 3ea6c8202..9d9ce88e7 100644 --- a/system/start.go +++ b/system/start.go @@ -1,14 +1,13 @@ package service import ( + "context" "fmt" "log" "net" "net/http" "os" - "github.com/SentimensRG/ctx" - "github.com/SentimensRG/ctx/sigctx" "github.com/pkg/errors" "github.com/titpetric/factory/resputil" @@ -75,7 +74,7 @@ func InitDb() error { return nil } -func Start() error { +func StartRestAPI(ctx context.Context) error { log.Printf("Starting "+os.Args[0]+", version: %v, built on: %v", version.Version, version.BuildTime) log.Println("Starting http server on address " + flags.http.Addr) listener, err := net.Listen("tcp", flags.http.Addr) @@ -87,9 +86,8 @@ func Start() error { go metrics.NewMonitor(flags.monitor.Interval) } - var deadline = sigctx.New() - go http.Serve(listener, Routes(ctx.AsContext(deadline))) - <-deadline.Done() + go http.Serve(listener, Routes(ctx)) + <-ctx.Done() return nil } diff --git a/vendor/github.com/crusttech/permit/LICENCE b/vendor/github.com/crusttech/permit/LICENCE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/vendor/github.com/crusttech/permit/LICENCE @@ -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/vendor/github.com/crusttech/permit/pkg/permit/client.go b/vendor/github.com/crusttech/permit/pkg/permit/client.go new file mode 100644 index 000000000..20eda3db5 --- /dev/null +++ b/vendor/github.com/crusttech/permit/pkg/permit/client.go @@ -0,0 +1,70 @@ +package permit + +import ( + "bytes" + "context" + "encoding/json" + "net/http" + + "github.com/pkg/errors" +) + +type ( + httpClient interface { + Do(req *http.Request) (*http.Response, error) + } +) + +const ( + permitCheckEndpoint = "https://permit.crust.tech/check" +) + +func Check(ctx context.Context, p Permit) (*Permit, error) { + return CheckWithClient(ctx, http.DefaultClient, p) +} + +func CheckWithClient(ctx context.Context, client httpClient, p Permit) (*Permit, error) { + if len(p.Key) == 0 { + return nil, errors.New("key not set") + } else if len(p.Key) != KeyLength { + return nil, errors.Errorf("invalid key length (%d chars)", len(p.Key)) + } + + buf := &bytes.Buffer{} + if err := json.NewEncoder(buf).Encode(p); err != nil { + return nil, errors.Wrap(err, "permit encoding failed") + } + + if req, err := http.NewRequest("POST", permitCheckEndpoint, buf); err != nil { + return nil, errors.Wrap(err, "unable to create request") + } else { + return CheckWithRequest(client, req.WithContext(ctx)) + } +} + +func CheckWithRequest(client httpClient, request *http.Request) (p *Permit, err error) { + var rsp *http.Response + if rsp, err = client.Do(request); err != nil { + return nil, errors.Wrap(err, "unable to fetch permit") + } + + defer rsp.Body.Close() + + switch rsp.StatusCode { + case http.StatusBadRequest: + return nil, errors.New("bad request") + case http.StatusNotFound: + return nil, errors.New("subscription key not found") + case http.StatusInternalServerError: + return nil, errors.New("subscription server error") + case http.StatusUnauthorized: + return nil, errors.New("subscription key invalid") + } + + p = &Permit{} + if err = json.NewDecoder(rsp.Body).Decode(&p); err != nil { + return nil, errors.Wrap(err, "unable to decode response into permit") + } + + return +} diff --git a/vendor/github.com/crusttech/permit/pkg/permit/permit.go b/vendor/github.com/crusttech/permit/pkg/permit/permit.go new file mode 100644 index 000000000..e193213b7 --- /dev/null +++ b/vendor/github.com/crusttech/permit/pkg/permit/permit.go @@ -0,0 +1,35 @@ +package permit + +import ( + "time" + + "github.com/pkg/errors" +) + +type ( + Permit struct { + Version uint `json:"version"` + Key string `json:"key"` + Domain string `json:"domain"` + Expires *time.Time `json:"expires,omitempty"` + Valid bool `json:"valid"` + Attributes map[string]int `json:"attributes"` + } +) + +const ( + // KeyLength + KeyLength = 64 +) + +var ( + PermitNotFound = errors.New("permit not found") +) + +func (p Permit) IsValid() bool { + return p.Valid && !p.Expired() +} + +func (p Permit) Expired() bool { + return p.Expires != nil && p.Expires.Before(time.Now()) +}