0

0

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

聖光之護

聖光之護

发布时间:2024-10-04 13:37:01

|

860人浏览过

|

来源于dev.to

转载

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

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


规划

我正在考虑这样的流程:

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

关注点分离

前端

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

后端

立即学习go语言免费学习笔记(深入)”;

  • 创建用于发送电子邮件的 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)

我将使用 golang 标准库中的 net/smtp。

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

51shop 网上商城系统
51shop 网上商城系统

51shop 由 PHP 语言开发, 使用快速的 MySQL 数据库保存数据 ,为中小型网站实现网上电子商务提供一个完美的解决方案.一、用户模块1. 用户注册:用户信息包括:用户ID、用户名、用户密码、性别、邮箱、省份、城市、 联系电话等信息,用户注册后不能立即使用,需由管理员激活账号,才可使用(此功能管理员可设置)2. 登录功能3. 资料修改:用户可修改除账号以后的所有资料4. 忘记密码:要求用

下载

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

smtp_host="smtp.zoho.in"
smtp_port="587"
smtp_email=""
smtp_password=""

我使用的是 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 := &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 以在电子邮件中发送
  • addotptoredis:以键值格式将 otp 添加到 redis,其中
key -> password-reset:
value -> hashed otp
expiry -> 10 mins

出于安全原因,我存储 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: %s\r\n" +
        "subject: task-inator 3000 password reset\r\n" +
        "\r\n" +
        "your otp for password reset is %s\r\n"

    // 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(&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如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

174

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

224

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

388

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

193

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

188

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
进程与SOCKET
进程与SOCKET

共6课时 | 0.3万人学习

Redis+MySQL数据库面试教程
Redis+MySQL数据库面试教程

共72课时 | 6.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号