Luzifer/password Docker镜像文档

镜像概述和主要用途

本镜像基于Luzifer/password项目构建，提供快速且安全的密码生成功能。该工具支持通过三种方式生成密码：Web界面、命令行工具（CLI）以及HTTP API，适用于需要高安全性密码的个人用户和开发场景。其核心设计专注于密码安全性，通过多重机制确保生成的密码难以被猜测或破解。

核心功能和特性

安全设计

• 无规律模式：密码不包含键盘或字母顺序中的常见模式
• 字符组多样性：根据是否使用特殊字符，密码包含3或4种不同字符组
• 无重复字符：生成的密码中不存在重复字符
• 数据隐私保护：API生成器不传输或存储任何与生成密码相关的数据

使用场景和适用范围

• 个人用户：通过Web界面或CLI快速生成安全密码
• 开发者：通过API将密码生成功能集成到应用系统中
• 自动化场景：在脚本或CI/CD流程中自动生成安全密码
• 自托管需求：可部署私有密码生成服务，确保完全控制密码生成过程

使用方法和配置说明

Web方式

直接使用基于本项目构建的托管服务：

• 访问 Secure Password 即可通过Web界面生成密码

CLI方式

通过Docker容器运行命令行工具生成密码：

基本用法

$ docker run --rm luzifer/password get -h
generate and return a secure random password

Usage:
  password get [flags]

Flags:
  -d, --date         prepend current date to XKCD style passwords (default true)
  -h, --help         help for get
  -j, --json         return output in JSON format
  -l, --length int   length of the generated password (default 20)
  -n, --number int   number of passwords to generate (default 1)
  -s, --special      use special characters in your password
  -x, --xkcd         use XKCD style password

生成示例

# 生成默认长度(20字符)密码
$ docker run --rm luzifer/password get
Vzupi4IaPbXmSQEX9A4e

# 生成32字符包含特殊字符的密码
$ docker run --rm luzifer/password get -l 32 -s
}d.sks(4J$2G]x52=k)WAN{M68LxEg}%

# 生成XKCD风格密码(4个单词)
$ docker run --rm luzifer/password get -l 4 -x
20190101.SeashellSupporterTumbleweedGeneral

API方式

自托管API服务

使用Docker部署私有密码生成API服务：

1. 启动API服务器容器：

$ docker run --rm -p 3000:3000 luzifer/password serve --port 3000

2. 服务参数说明：

$ docker run --rm luzifer/password serve -h
start an API server to request passwords

Usage:
  password serve [flags]

Flags:
  -h, --help       help for serve
      --port int   port to listen on (default 3000)

3. 请求密码示例：

$ curl "http://localhost:3000/v1/getPassword?length=20&special=true"
}d.sks(4J$2G]x52=k)WAN{M68LxEg}%

托管API服务

直接使用公共托管服务：

$ curl "[***]"
0M4L-1lT:@2&7,p,o-;

API参数说明

• /v1/getPassword - 密码生成接口
  • date=true - 是否在XKCD风格密码前添加日期（默认true）
  • length=20 - 密码长度（API支持4-128字符，更长需使用CLI）
  • special=false - 是否包含特殊字符
  • xkcd=false - 是否生成XKCD风格密码（多单词组合）

作为代码库集成

在Go项目中集成密码生成功能：

package main

import pwd "github.com/Luzifer/password/v2/lib"

func getPassword() (string, error) {
    return pwd.NewSecurePassword().GeneratePassword(16, false)
}

基准测试

项目包含完善的测试和性能基准，每次代码推送由Travis CI自动运行：

[![Build Status]([***]

典型基准测试结果：

$ go test -bench .
goos: linux
goarch: amd64
pkg: github.com/Luzifer/password/lib
BenchmarkGeneratePasswords8Char-8                  20000             65469 ns/op
BenchmarkGeneratePasswords8CharSpecial-8           20000             97659 ns/op
BenchmarkGeneratePasswords16Char-8                 20000             84215 ns/op
BenchmarkGeneratePasswords16CharSpecial-8          20000             92885 ns/op
BenchmarkGeneratePasswords32Char-8                 10000            152436 ns/op
BenchmarkGeneratePasswords32CharSpecial-8          10000            144352 ns/op
BenchmarkGeneratePasswords128Char-8                 1000           2199011 ns/op
BenchmarkGeneratePasswords128CharSpecial-8          2000           1089225 ns/op
BenchmarkGeneratePasswords4Words-8                200000              9472 ns/op
BenchmarkGeneratePasswords20Words-8               100000             14098 ns/op
PASS
ok      github.com/Luzifer/password/lib 21.624s