diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..07198d8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +# See http://help.github.com/ignore-files/ for more about ignoring files. + +# compiled output +/dist +/tmp +/tmps +/logs + +# dependencies +/node_modules + +# IDEs and editors +/.idea +.project +.classpath +.c9/ +*.launch +.settings/ + +# IDE - VSCode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +# misc +/.sass-cache +/connect.lock +/coverage/* +/libpeerconnection.log +npm-debug.log +testem.log +/typings + +# e2e +/e2e/*.js +/e2e/*.map + +#System Files +.DS_Store +Thumbs.db +*.exe \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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/README.md b/README.md new file mode 100644 index 0000000..23f157c --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# [Golang portier](https://github.com/vlorc/portier) +[中文](README_CN.md) + +[![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![codebeat badge](https://codebeat.co/badges/c41b426c-4121-4dc8-99c2-f1b60574be64)](https://codebeat.co/projects/github-com-vlorc-portier-master) +[![Go Report Card](https://goreportcard.com/badge/github.com/vlorc/portier)](https://goreportcard.com/report/github.com/vlorc/portier) +[![Build Status](https://travis-ci.org/vlorc/portier.svg?branch=master)](https://travis-ci.org/vlorc/portier?branch=master) +[![Coverage Status](https://coveralls.io/repos/github/vlorc/portier/badge.svg?branch=master)](https://coveralls.io/github/vlorc/portier?branch=master) + +Nginx cas! 200+ lines of small email authentication service + +![login](img/login.png) + +## Installing + go install github.com/vlorc/portier@latest + +## Quick Start + ++ portier + +```shell +./portier \ + -cookie.domain .example.com \ + -mail.addr smtp.exmail.qq.com:465 \ + -mail.user xxxx \ + -mail.pass xxxx +``` + ++ app + +```shell +python -m http.server -b 127.0.0.1 8080 +``` + ++ nginx + +```shell +nginx -c example/nginx.conf +``` + +# Keyword + +**nginx cas, mail verify, auth_request, portier** \ No newline at end of file diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..d557618 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,43 @@ +# [Golang portier](https://github.com/vlorc/portier) +[英文](README.md) + +[![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![codebeat badge](https://codebeat.co/badges/c41b426c-4121-4dc8-99c2-f1b60574be64)](https://codebeat.co/projects/github-com-vlorc-portier-master) +[![Go Report Card](https://goreportcard.com/badge/github.com/vlorc/portier)](https://goreportcard.com/report/github.com/vlorc/portier) +[![Build Status](https://travis-ci.org/vlorc/portier.svg?branch=master)](https://travis-ci.org/vlorc/portier?branch=master) +[![Coverage Status](https://coveralls.io/repos/github/vlorc/portier/badge.svg?branch=master)](https://coveralls.io/github/vlorc/portier?branch=master) + +Nginx cas! 200+ 行实现的小巧邮箱认证服务 + +![login](img/login.png) + +## 安装 + go install github.com/vlorc/portier@latest + +## 使用 + ++ portier + +```shell +./portier -lang cn \ + -cookie.domain .example.com \ + -mail.addr smtp.exmail.qq.com:465 \ + -mail.user xxxx \ + -mail.pass xxxx +``` + ++ app + +```shell +python -m http.server -b 127.0.0.1 8080 +``` + ++ nginx + +```shell +nginx -c example/nginx.conf +``` + +# 关键字 + +**nginx cas, mail verify, auth_request, portier** \ No newline at end of file diff --git a/example/auth.conf b/example/auth.conf new file mode 100644 index 0000000..6614a46 --- /dev/null +++ b/example/auth.conf @@ -0,0 +1,2 @@ + auth_request @verify; + error_page 401 = @error401; \ No newline at end of file diff --git a/example/cas.conf b/example/cas.conf new file mode 100644 index 0000000..a07a170 --- /dev/null +++ b/example/cas.conf @@ -0,0 +1,10 @@ +location = @verify { + internal; + proxy_set_header Content-Length ""; + proxy_pass_request_body off; + proxy_pass http://cas-server/verify; +} + +location @error401 { + return 302 http://cas.example.com/login?redirect=$scheme://$http_host$request_uri; +} diff --git a/example/cas.example.com.conf b/example/cas.example.com.conf new file mode 100644 index 0000000..6defb52 --- /dev/null +++ b/example/cas.example.com.conf @@ -0,0 +1,8 @@ +server { + listen 80 ; + server_name cas.example.com; + + location / { + proxy_pass http://cas-server; + } +} \ No newline at end of file diff --git a/example/host.example.com.conf b/example/host.example.com.conf new file mode 100644 index 0000000..99a11c5 --- /dev/null +++ b/example/host.example.com.conf @@ -0,0 +1,11 @@ +server { + listen 80 ; + server_name host.example.com; + + include cas.conf; + + location / { + include auth.conf; + proxy_pass http://host-server; + } +} \ No newline at end of file diff --git a/example/nginx.conf b/example/nginx.conf new file mode 100644 index 0000000..98ed045 --- /dev/null +++ b/example/nginx.conf @@ -0,0 +1,18 @@ + +worker_processes 1; + +events { + worker_connections 1024; +} + +http { + upstream cas-server { + server 127.0.0.1:4567; + } + upstream host-server { + server 127.0.0.1:8080; + } + + include cas.example.com.conf; + include host.example.com.conf; +} \ No newline at end of file diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..7b91d2e --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/vlorc/portier + +go 1.16 diff --git a/img/login.png b/img/login.png new file mode 100644 index 0000000..760b07d Binary files /dev/null and b/img/login.png differ diff --git a/main.go b/main.go new file mode 100644 index 0000000..eb53e61 --- /dev/null +++ b/main.go @@ -0,0 +1,257 @@ +package main + +import ( + "bytes" + "crypto/hmac" + "crypto/md5" + "crypto/rand" + "crypto/tls" + "embed" + "encoding/hex" + "encoding/json" + "flag" + "html/template" + "io" + "io/fs" + "log" + "math/big" + "net" + "net/http" + "net/smtp" + "net/url" + "os" + "path" + "regexp" + "strconv" + "strings" + "sync" + "time" + "unsafe" +) + +//go:embed views +var views embed.FS + +func mailer(addr *string, secure *bool, user, pass *string) func(string, *template.Template, map[string]interface{}) error { + return func(to string, tmpl *template.Template, data map[string]interface{}) error { + var body bytes.Buffer + data["to"] = to + data["from"] = *user + if err := tmpl.ExecuteTemplate(&body, "captcha.html", data); nil != err { + return err + } + host, port, err := net.SplitHostPort(*addr) + var conn net.Conn + if port == "465" || *secure { + conn, err = tls.Dial("tcp", *addr, &tls.Config{InsecureSkipVerify: *secure}) + } else { + conn, err = net.Dial("tcp", *addr) + } + if err != nil { + return err + } + cli, err := smtp.NewClient(conn, host) + if nil != err { + conn.Close() + return err + } + defer cli.Close() + if ok, _ := cli.Extension("AUTH"); ok { + if err = cli.Auth(smtp.PlainAuth("", *user, *pass, host)); nil != err { + return err + } + } + if err = cli.Mail(*user); nil != err { + return err + } + if err = cli.Rcpt(to); nil != err { + return err + } + w, err := cli.Data() + if nil != err { + return err + } + if _, err = io.Copy(w, &body); nil != err { + return err + } + if err = w.Close(); nil != err { + return err + } + return cli.Quit() + } +} + +func nonce() string { + v, _ := rand.Int(rand.Reader, big.NewInt(8999)) + return strconv.FormatInt(v.Int64()+1000, 10) +} + +func tostring(b []byte) string { + return *(*string)(unsafe.Pointer(&b)) +} + +func tobytes(s string) []byte { + return *(*[]byte)(unsafe.Pointer(&s)) +} + +func verify(secret string, value string) bool { + i := strings.Index(value, ".") + if i <= 0 { + return false + } + if t, _ := strconv.ParseInt(value[:i], 16, 63); t < time.Now().Unix() { + return false + } + var digest [32]byte + h := hmac.New(md5.New, tobytes(secret)) + h.Write(tobytes(value[:i])) + hex.Encode(digest[16:], h.Sum(digest[:0])[4:12]) + return value[i+1:] == tostring(digest[16:32]) +} + +func signature(secret string, ttl int) string { + var digest [16]byte + var cache [64]byte + b := strconv.AppendInt(cache[:0], time.Now().Unix()+int64(ttl), 16) + h := hmac.New(md5.New, tobytes(secret)) + h.Write(b) + b = append(b, '.') + n := hex.Encode(cache[len(b):], h.Sum(digest[:0])[4:12]) + return string(cache[:len(b)+n]) +} + +func session(secret, domain, name *string, expires *int) (func(*http.Request) bool, func(http.ResponseWriter) bool) { + return func(req *http.Request) bool { + if c, _ := req.Cookie(*name); nil != c { + return verify(*secret, c.Value) + } + return false + }, + func(resp http.ResponseWriter) bool { + http.SetCookie(resp, &http.Cookie{ + Name: *name, + Value: signature(*secret, *expires), + Domain: *domain, + MaxAge: *expires, + HttpOnly: true, + }) + return true + } +} + +func hostname(redirect string) string { + if u, _ := url.Parse(redirect); nil != u { + return u.Hostname() + } + return "" +} + +func match(str *string) func(string) bool { + re := regexp.MustCompile("^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$") + return func(val string) bool { + return re.MatchString(val) && strings.HasSuffix(val, *str) + } +} + +func querier(key *string) func(*http.Request) string { + return func(req *http.Request) string { + if "" != req.URL.RawQuery { + return req.URL.Query().Get(*key) + } + return "" + } +} + +type filesystem []fs.FS +type subsystem struct { + fsys fs.FS + dir string +} + +func (f *subsystem) Open(name string) (fs.File, error) { + return f.fsys.Open(path.Join(f.dir, name)) +} + +func (f filesystem) Open(name string) (file fs.File, err error) { + for i := range f { + if file, err = f[i].Open(name); nil == err { + break + } + } + return +} + +func (f filesystem) Json(name string, val interface{}) error { + if buf, err := fs.ReadFile(f, name); nil != err { + return err + } else { + return json.Unmarshal(buf, val) + } +} + +func main() { + lang := flag.String("lang", "en", "language") + fsys := filesystem{os.DirFS("."), &subsystem{views, "views"}} + addr := flag.String("addr", "127.0.0.1:4567", "listen address") + uri := flag.String("path", "/login", "login path") + check, setup := session( + flag.String("cookie.secret", "portier", "cookie secret"), + flag.String("cookie.domain", "", "cookie domain"), + flag.String("cookie.name", "portier", "cookie name"), + flag.Int("cookie.expires", 3600, "cookie expires"), + ) + query := querier(flag.String("redirect", "redirect", "redirect key")) + send := mailer( + flag.String("mail.addr", "", "mail address"), + flag.Bool("mail.ssl", false, "mail ssl"), + flag.String("mail.user", "", "mail username"), + flag.String("mail.pass", "", "mail password"), + ) + valid := match(flag.String("mail.suffix", "", "mail suffix")) + flag.Parse() + + mapping := sync.Map{} + dict := map[string]string{} + tmpl, err := template.ParseFS(fsys, "login.html", "captcha.html") + if nil != err { + log.Println(err.Error()) + } + if nil != fsys.Json("lang.json", &dict) { + fsys.Json(*lang+".json", &dict) + } + + login := func(resp http.ResponseWriter, req *http.Request, redirect string) bool { + mail := req.FormValue("mail") + code := req.FormValue("code") + data := map[string]interface{}{"dict": dict, "mail": mail, "domain": hostname(redirect), "now": time.Now().Format("2006-01-02 15:04:05")} + switch { + case http.MethodGet == req.Method: + case !valid(mail): + data["message"] = dict["mail_reject"] + case "" == code: + code = nonce() + mapping.Store(mail, code) + data["code"] = code + data["required"] = "required" + data["message"] = dict["captcha_sent"] + log.Println("send mail:", mail, "code:", code, "error:", send(mail, tmpl, data)) + default: + if v, ok := mapping.LoadAndDelete(mail); ok && code == v.(string) { + return setup(resp) + } + data["message"] = dict["captcha_failed"] + } + tmpl.ExecuteTemplate(resp, "login.html", data) + return false + } + + http.ListenAndServe(*addr, http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) { + if redirect, page := query(req), *uri == req.URL.Path; check(req) || (page && login(resp, req, redirect)) { + if "" != redirect { + http.Redirect(resp, req, redirect, http.StatusFound) + } + } else if !page { + resp.WriteHeader(http.StatusUnauthorized) + } + })) +} diff --git a/views/captcha.html b/views/captcha.html new file mode 100644 index 0000000..511f37f --- /dev/null +++ b/views/captcha.html @@ -0,0 +1,32 @@ +Subject: {{ .dict.subject }} +To: {{ .to }} +From: {{ .from }} +MIME-version: 1.0; +Content-Type: text/html; charset="UTF-8"; + + + + + + + + + + + + + +
+
+
+ + {{ .dict.mail_content }} {{ .code }} + +
+
+
+ \ No newline at end of file diff --git a/views/cn.json b/views/cn.json new file mode 100644 index 0000000..f46b212 --- /dev/null +++ b/views/cn.json @@ -0,0 +1,9 @@ +{ + "title": "邮箱验证", + "submit": "提交", + "subject": "验证码", + "mail_content": "您收到此邮件,以便我们确认您的电子邮件地址, 验证码:", + "captcha_failed": "咋啦还不对,再来一发", + "captcha_sent": "验证码已飞奔向您来咯", + "mail_reject": "这邮箱我不支持哦" +} \ No newline at end of file diff --git a/views/en.json b/views/en.json new file mode 100644 index 0000000..060c82b --- /dev/null +++ b/views/en.json @@ -0,0 +1,9 @@ +{ + "title": "Mail Verify", + "submit": "OK", + "subject": "Captcha", + "mail_content": "You received this email so that we may confirm your email address, please enter captcha code:", + "mail_reject": "Sorry, this email not supported", + "captcha_failed": "Verify failed, please re-enter", + "captcha_sent": "The captcha code has been sent" +} \ No newline at end of file diff --git a/views/login.html b/views/login.html new file mode 100644 index 0000000..0d0b852 --- /dev/null +++ b/views/login.html @@ -0,0 +1,93 @@ + + + + + {{ .dict.title }} + + + + +

{{ .dict.title }}

+
+
+ + + +
+
+

{{ .message }}

+
+
+ \ No newline at end of file