您的位置 首页 知识分享

密码重置功能:在 Golang 中发送电子邮件

在撰写本文时,我正在我的应用程序 task-inator 3000 中实现一项为用户重置密码的功能。只是记录我…

密码重置功能:在 Golang 中发送电子邮件

在撰写本文时,我正在我的应用程序 task-inator 3000 中实现一项为用户重置密码的功能。只是记录我的思考过程和采取的步骤


规划

我正在考虑这样的流程:

  1. 用户点击“忘记密码?”按钮
  2. 向请求电子邮件的用户显示模式
  3. 检查电子邮件是否存在,并将 10 个字符长的 otp 发送到电子邮件
  4. modal 现在要求输入 otp 和新密码
  5. 密码已为用户进行哈希处理和更新

关注点分离

前端

  • 创建一个模态来输入电子邮件
  • 相同的模式然后接受 otp 和新密码

后端

立即学习“”;

  • 创建用于发送电子邮件的 api
  • 创建重置密码的api

我将从后端开始

后端

如上所述,我们需要两个 api

1. 发送邮件

api只需要接收用户的邮件,成功后不返回任何内容。因此,创建控制器如下:

// controllers/passwordreset.go func sendpasswordresetemail(c *fiber.ctx) error {     type input struct {         email string `json:"email"`     }      var input input      err := c.bodyparser(&input)     if err != nil {         return c.status(fiber.statusbadrequest).json(fiber.map{             "error": "invalid data",         })     }      // todo: send email with otp to user      return c.sendstatus(fiber.statusnocontent) } 
登录后复制

现在为其添加一条路线:

// routes/routes.go  // password reset api.post("/send-otp", controllers.sendpasswordresetemail) 
登录后复制

我将使用 中的 net/smtp。

阅读文档后,我认为最好在项目初始化时创建一个 smtpclient。因此,我会在 /config 目录中创建一个文件 smtpconnection.go。

在此之前,我会将以下环境变量添加到我的 .env 或生产服务器中。

smtp_host="smtp.zoho.in" smtp_port="587" smtp_email="<myemail>" smtp_password="<mypassword>" </mypassword></myemail>
登录后复制

我使用的是 zohomail,因此其 smtp 主机和端口(用于 tls)如此处所述。

// config/smtpconnection.go package config  import (     "crypto/tls"     "fmt"     "net/smtp"     "os" )  var smtpclient *smtp.client  func smtpconnect() {     host := os.getenv("smtp_host")     port := os.getenv("smtp_port")     email := os.getenv("smtp_email")     password := os.getenv("smtp_password")      smtpauth := smtp.plainauth("", email, password, host)      // connect to smtp server     client, err := smtp.dial(host + ":" + port)     if err != nil {         panic(err)     }      smtpclient = client     client = nil      // initiate tls handshake     if ok, _ := smtpclient.extension("starttls"); ok {         config := &amp;tls.config{servername: host}         if err = smtpclient.starttls(config); err != nil {             panic(err)         }     }      // authenticate     err = smtpclient.auth(smtpauth)     if err != nil {         panic(err)     }      fmt.println("smtp connected") } 
登录后复制

为了抽象,我将在/utils 中创建一个passwordreset.go 文件。该文件目前具有以下功能:

  • 生成 otp:生成一个唯一的字母数字 10 位 otp 以在电子邮件中发送
  • addotpto:以键值格式将 otp 添加到 redis,其中
key -&gt; password-reset:<email> value -&gt; hashed otp expiry -&gt; 10 mins </email>
登录后复制

出于安全原因,我存储 otp 的哈希值而不是 otp 本身

  • sendotp:将生成的 otp 发送到用户的电子邮件

在编写代码时,我发现我们需要 5 个常量:

  • otp 的 redis 密钥前缀
  • otp 过期时间
  • 用于 otp 生成的字符集
  • 电子邮件模板
  • otp 长度

我会立即将它们添加到 /utils/constants.go

// utils/constants.go package utils  import "time"  const (     authtokenexp       = time.minute * 10     refreshtokenexp    = time.hour * 24 * 30 // 1 month     blacklistkeyprefix = "blacklisted:"     otpkeyprefix       = "password-reset:"     otpexp             = time.minute * 10     otpcharset         = "abcdefghijklmnopqrstuvwxyz1234567890"     emailtemplate      = "to: %srn" +         "subject: task-inator 3000 password resetrn" +         "rn" +         "your otp for password reset is %srn"      // public because needed for testing     otplength = 10 ) 
登录后复制

(请注意,我们将从 crypto/rand 导入,而不是 math/rand,因为它将提供真正的随机性)

// utils/passwordreset.go package utils  import (     "context"     "crypto/rand"     "fmt"     "math/big"     "os"     "task-inator3000/config"      "golang.org/x/crypto/bcrypt" )  func generateotp() string {     result := make([]byte, otplength)     charsetlength := big.newint(int64(len(otpcharset)))      for i := range result {         // generate a secure random number in the range of the charset length         num, _ := rand.int(rand.reader, charsetlength)         result[i] = otpcharset[num.int64()]     }      return string(result) }  func addotptoredis(otp string, email string, c context.context) error {     key := otpkeyprefix + email      // hashing the otp     data, _ := bcrypt.generatefrompassword([]byte(otp), 10)      // storing otp with expiry     err := config.redisclient.set(c, key, data, otpexp).err()     if err != nil {         return err     }      return nil }  func sendotp(otp string, recipient string) error {     sender := os.getenv("smtp_email")     client := config.smtpclient      // setting the sender     err := client.mail(sender)     if err != nil {         return err     }      // set recipient     err = client.rcpt(recipient)     if err != nil {         return err     }      // start writing email     writecloser, err := client.data()     if err != nil {         return err     }      // contents of the email     msg := fmt.sprintf(emailtemplate, recipient, otp)      // write the email     _, err = writecloser.write([]byte(msg))     if err != nil {         return err     }      // close writecloser and send email     err = writecloser.close()     if err != nil {         return err     }      return nil } 
登录后复制

函数generateotp()无需模拟即可测试(单元测试),因此为它编写了一个简单的测试

package utils_test  import (     "task-inator3000/utils"     "testing" )  func testgenerateotp(t *testing.t) {     result := utils.generateotp()      if len(result) != utils.otplength {         t.errorf("length of otp was not %v. otp: %v", utils.otplength, result)     } } 
登录后复制

现在我们需要将它们全部放在控制器内。在这之前,我们需要确保数据库中存在提供的电子邮件地址。

控制器的完整代码如下:

func sendpasswordresetemail(c *fiber.ctx) error {     type input struct {         email string `json:"email"`     }      var input input      err := c.bodyparser(&amp;input)     if err != nil {         return c.status(fiber.statusbadrequest).json(fiber.map{             "error": "invalid data",         })     }      // check if user with email exists     users := config.db.collection("users")     filter := bson.m{"_id": input.email}     err = users.findone(c.context(), filter).err()     if err != nil {         if err == mongo.errnodocuments {             return c.status(fiber.statusnotfound).json(fiber.map{                 "error": "user with given email not found",             })         }          return c.status(fiber.statusinternalservererror).json(fiber.map{             "error": "error while finding in the database:n" + err.error(),         })     }      // generate otp and add it to redis     otp := utils.generateotp()     err = utils.addotptoredis(otp, input.email, c.context())     if err != nil {         return c.status(fiber.statusinternalservererror).json(fiber.map{             "error": err.error(),         })     }      // send the otp to user through email     err = utils.sendotp(otp, input.email)     if err != nil {         return c.status(fiber.statusinternalservererror).json(fiber.map{             "error": err.error(),         })     }      return c.sendstatus(fiber.statusnocontent) } 
登录后复制

我们可以通过向正确的 url 发送 post 请求来测试 api。 curl 示例如下:

curl --location 'localhost:3000/api/send-otp'  --header 'Content-Type: application/json'  --data-raw '{     "email": "yashjaiswal.cse@gmail.com" }' 
登录后复制

我们将在本系列的下一部分中创建下一个 api – 用于重置密码

以上就是功能:在 Golang 中发送电子邮件的详细内容,更多请关注php中文网其它相关文章!

本文来自网络,不代表甲倪知识立场,转载请注明出处:http://www.spjiani.cn/wp/2968.html

作者: nijia

发表评论

您的电子邮箱地址不会被公开。

联系我们

联系我们

0898-88881688

在线咨询: QQ交谈

邮箱: email@wangzhan.com

工作时间:周一至周五,9:00-17:30,节假日休息

关注微信
微信扫一扫关注我们

微信扫一扫关注我们

关注微博
返回顶部