技术文档：authcookie 包使用详解

1. 安装指南

在开始使用 authcookie 包之前，请确保您的环境中已经安装了 Go 语言环境。authcookie 包可以从 GitHub 仓库克隆或直接使用 go get 命令进行安装。

go get github.com/dchest/authcookie

安装完成后，您可以在您的 Go 项目中导入并使用 authcookie 包。

2. 项目的使用说明

authcookie 包用于生成和验证签名的认证 cookies。这些 cookies 由过期时间、登录名和签名组成，使用 Base64 编码进行编码。

生成认证 Cookie

以下是如何生成一个认证 cookie 的示例：

package main

import (
    "github.com/dchest/authcookie"
    "time"
)

func main() {
    secret := []byte("my secret key")
    // 生成一个有效期为24小时的 cookie，用户名为 "bender"
    cookie := authcookie.NewSinceNow("bender", 24*time.Hour, secret)
    // 输出生成的 cookie
    println(cookie)
}

验证认证 Cookie

以下是如何验证一个认证 cookie 的示例：

package main

import (
    "github.com/dchest/authcookie"
)

func main() {
    secret := []byte("my secret key")
    // 假设从用户浏览器接收到的 cookie
    cookie := "Tajh02JlbmRlcskYMxowgwPj5QZ94jaxhDoh3n0Yp4hgGtUpeO0YbMTY"
    // 从 cookie 中提取登录名
    login := authcookie.Login(cookie, secret)
    if login != "" {
        // 访问授权
        println("Access granted for user:", login)
    } else {
        // 访问拒绝
        println("Access denied")
    }
}

3. 项目API使用文档

以下是 authcookie 包提供的函数及其使用说明：

func Login(cookie string, secret []byte) string

Login 函数从给定的 cookie 中提取有效的登录名，并使用给定的密钥进行验证。如果验证失败或 cookie 已过期，函数返回空字符串。

func New(login string, expires time.Time, secret []byte) string

New 函数返回一个给定登录名、过期时间和密钥的签名认证 cookie。如果登录名为空，函数返回空字符串。

func NewNoPadding(login string, expires time.Time, secret []byte) string

NewNoPadding 函数与 New 类似，但返回的 cookie 不包含 Base64 填充字符。

func NewSinceNow(login string, dur time.Duration, secret []byte) string

NewSinceNow 函数返回一个给定登录名、当前时间后的持续时间密钥的签名认证 cookie。

func Parse(cookie string, secret []byte) (login string, expires time.Time, err error)

Parse 函数使用给定的密钥验证 cookie，并从 cookie 中提取登录名和过期时间。如果 cookie 验证失败或格式不正确，函数返回错误。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明，您可以使用以下命令进行安装：

go get github.com/dchest/authcookie