All skills
gogf avatar

/goframe-v2

@911705d
by GoFramegogf/skills81 stars
3

GoFrame v2 development skill. Use only when the target Go project uses or is explicitly adopting GoFrame v2: the nearest go.mod requires github.com/gogf/gf/v2, existing Go files import github.com/gogf/gf/v2 or any github.com/gogf/gf/v2/... component package, or the user asks to scaffold, migrate, or build with GoFrame. Trigger for GoFrame-backed Go work such as APIs/controllers/services, middleware, routing/config, ORM/DAO/DO/entity/database operations, gf CLI/codegen, HTTP/gRPC services, and microservice conventions. Do not trigger for generic Go projects without GoFrame evidence, frontend-only work, shell scripts, or unrelated infrastructure tasks.

Use this Skill: https://skilld.dev/gh/gogf/skills/goframe-v2

This session only. Nothing lands on disk.

examplesdatabaseencoded-passREADME.ZH.MD

≈1k tokens on demand. Your agent reads this file only when SKILL.md points to it.

加密密码数据库连接

介绍

本示例展示了如何在GoFrame中实现一个自定义数据库驱动,用于处理加密的数据库密码。该实现允许您在配置文件中存储加密的密码,这些密码在建立数据库连接时会自动解密。

示例使用AES加密结合Base64编码来保护数据库密码,为应用程序的数据库凭据提供额外的安全层。

环境要求

目录结构

.
├── config.yaml           # 包含加密数据库密码的配置文件
├── dbdriver/             # 自定义数据库驱动实现
│   ├── dbdriver.go       # 带密码解密功能的自定义 MySQL 驱动
│   └── dbdriver_test.go  # 密码加密/解密测试
├── go.mod                # Go 模块文件
├── go.sum                # Go 模块校验和
└── main.go               # 应用程序入口点

功能特点

  • 自定义数据库驱动实现
  • 使用AES-CBC进行密码加密
  • 使用Base64编码处理二进制数据
  • 与GoFrame数据库操作无缝集成
  • 安全存储数据库凭据

设置步骤

  1. 克隆代码库:

    git clone https://github.com/gogf/examples.git
    cd examples/database/encoded-pass
  2. 安装依赖:

    go mod tidy
  3. 设置 MySQL 数据库:

    docker run --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=12345678 -e MYSQL_DATABASE=test -d mysql:8.0
  4. 使用加密的数据库密码更新配置文件(参见下面的密码加密部分)。

  5. 运行应用程序:

    go run main.go

密码加密

要加密您的数据库密码:

  1. 运行演示加密过程的测试函数:

    cd dbdriver
    go test -v -run Test_Encode
  2. 测试将输出:

    • 原始密码
    • Base64编码的密码
    • AES加密并 Base64 编码的密码(在 config.yaml 中使用这个)
    • 解密后的密码(用于验证)
  3. 使用您的加密密码更新 config.yaml 文件:

    database:
      default:
        link: "mysql:root:您的加密密码@tcp(127.0.0.1:3306)/test?loc=Local&parseTime=true"

实现细节

自定义数据库驱动扩展了GoFrame提供的标准MySQL驱动,并重写了Open接口方法来处理密码解密:

  1. 从数据库连接字符串中提取加密密码
  2. 对密码进行 Base64 解码,获取二进制加密数据
  3. 使用预定义的加密密钥应用 AES-CBC 解密
  4. 对解密后的数据再次进行 Base64 解码,获取原始密码
  5. 使用原始密码建立数据库连接

注意事项

  • 在此示例中,加密密钥是硬编码的(encodeKey)。在生产环境中,您应该使用安全的方法来管理此密钥。
  • 这种方法可以扩展到加密配置文件中的其他敏感信息。
  • 示例使用AES-CBC加密,但您可以修改它以使用GoFrame提供的其他加密算法。

Source: SKILL.md on GitHub

1 alert16d5 checks · Risk MEDIUM
  • Gen Agent Trust Hub16d

    The skill provides a comprehensive development guide and code examples for the GoFrame v2 framework. While highly informative for Go developers, it contains several examples with hardcoded placeholder secrets, tokens, and specific local file paths to sensitive configuration files (like Kubernetes credentials). These elements are provided for demonstration purposes but represent insecure practices if used in production without modification.

  • Socket16d

    5 alerts: gptSecurity, gptAnomaly

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    227/949 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at 911705d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 months ago.

Steadyupdated 4 months ago
  • Go
  • Database
  • goframe
  • orm
  • http
  • grpc
  • microservices
  • crud
  • scaffolding
  • middleware

README badge

README badge for gogf/skills

Provides instruction and conventions for developing with GoFrame v2, a modular Go framework for building HTTP and gRPC services, microservices, and database operations using its ORM, CLI tooling, and project scaffolding. Use this skill when the target project has GoFrame v2 as a dependency or when the user requests scaffolding, migrations, or service development with GoFrame conventions.

Generated from the current SKILL.md.

When should I use this skill?
Use this skill only when your Go project uses GoFrame v2, indicated by github.com/gogf/gf/v2 in go.mod or imports. Do not use for generic Go projects, frontend work, or infrastructure tasks unrelated to GoFrame.
Should I manually set created_at and updated_at fields?
No. GoFrame automatically writes created_at on insert and updated_at on insert/update/save. Manually setting these fields is redundant and violates project conventions.
What should I use for database operations instead of g.Map?
Always use DO objects from internal/model/do/. DO struct fields are interface{}, unset fields remain nil and are automatically ignored by the ORM.
How does soft delete work in GoFrame?
Call Delete() on the DAO; GoFrame automatically converts it to UPDATE SET deleted_at = NOW(). Queries automatically filter out soft-deleted rows without requiring manual WhereNull conditions.
Where should I implement business logic?
Implement business logic directly in the service/ directory. Do not use the logic/ directory unless explicitly requested.

Generated from the current SKILL.md. These answers refresh after source changes.