El controlador alibabacloud-encdb-mysql-go-client le permite conectar una aplicación de Go a una base de datos confidencial de PolarDB sin modificar su código existente. Este controlador implementa la interfaz estándar de Go database/sql/driver y es totalmente compatible con el controlador de MySQL para Go de la comunidad. Una vez que proporciona una clave maestra de cifrado (MEK), el controlador procesa todo el cifrado y descifrado de forma local. Además, devuelve los datos en texto plano a su aplicación de manera transparente.
Cómo funciona
Instale el controlador. Este se registra automáticamente con el nombre
encmysql.Abra una conexión con
sql.Open("encmysql", dsn). Incluya la MEK y el algoritmo de cifrado (ENC_ALGO) en la cadena de conexión.El controlador procesa la MEK de forma local y la protege mediante cifrado de sobre antes de enviar cualquier dato al servidor. El servidor nunca recibe la clave en texto plano.
Requisitos previos
Antes de empezar, compruebe que cuenta con lo siguiente:
La función always-confidential habilitada en su clúster de PolarDB, con las reglas de cifrado configuradas. Consulte Enable the always-confidential feature
Los datos de conexión de su base de datos confidencial: nombre de host, puerto, nombre de la base de datos (
dbname), nombre de usuario y contraseñaGo 1.18 o una versión posterior instalada
Instalar el controlador
Ejecute el siguiente comando en el directorio de su proyecto:
go get github.com/aliyun/alibabacloud-encdb-mysql-go-client@latest
El controlador es de código abierto. Para consultar el código fuente, visite alibabacloud-encdb-mysql-go-client en GitHub .
Conectarse a una base de datos confidencial
Utilice el siguiente formato de DSN con sql.Open:
<username>:<password>@tcp(<hostname>:<port>)/<dbname>?MEK=<mek>&ENC_ALGO=<enc-algo>
Reemplace los marcadores de posición con sus valores reales:
|
Marcador de posición |
Descripción |
Dónde encontrarlo |
|
|
Nombre de usuario de la base de datos |
Las credenciales de su clúster de PolarDB |
|
|
Contraseña de la base de datos |
Las credenciales de su clúster de PolarDB |
|
|
Endpoint del clúster (nombre de dominio) |
La consola de PolarDB, en los detalles de conexión |
|
|
Número de puerto |
La consola de PolarDB, en los detalles de conexión |
|
|
Nombre de la base de datos |
Su clúster de PolarDB |
|
|
Clave maestra: una cadena hexadecimal de 32 caracteres |
Genérela usted mismo (consulte Parámetro MEK) |
|
|
Algoritmo de cifrado |
Elija uno de los algoritmos compatibles (consulte Parámetro ENC_ALGO) |
Para agregar varios parámetros de consulta, sepárelos con &.
En el código:
db, err := sql.Open("encmysql", "<username>:<password>@tcp(<hostname>:<port>)/<dbname>?MEK=<mek>&ENC_ALGO=<enc-algo>")
if err != nil {
log.Fatal("failed to open database connection:", err)
}
defer db.Close()
if err = db.Ping(); err != nil {
log.Fatal("failed to reach database:", err)
}
sql.Openopera de forma diferida y no establece la conexión de inmediato. Llame adb.Ping()después para comprobar que la conexión está activa.
Parámetros MEK y ENC_ALGO
MEK
La MEK (Master Key) es la clave maestra del cliente (CMK) que usted proporciona. Constituye la credencial raíz para acceder a los datos cifrados.
|
Atributo |
Detalle |
|
Formato |
Cadena hexadecimal de 32 caracteres (16 bytes) |
|
Ejemplo |
|
|
Métodos de generación |
|
|
Manejo de seguridad |
Se procesa de forma local. Se protege mediante cifrado de sobre antes de enviarse al servidor, por lo que nunca se expone en texto plano |
La base de datos confidencial no almacena, gestiona, respalda ni regenera su clave maestra. Si pierde la MEK, perderá el acceso a sus datos cifrados de forma permanente. Respalde su MEK de manera segura antes de usarla en producción.
ENC_ALGO
El parámetro ENC_ALGO especifica el algoritmo de cifrado que se aplica a los datos protegidos. Se admiten dos categorías: Advanced Encryption Standard (AES) y SM4 (el estándar criptográfico nacional chino).
|
Algoritmo |
Notas |
|
|
Predeterminado |
|
|
|
|
|
|
|
|
No recomendado: menor seguridad |
|
|
|
|
|
|
|
|
|
|
|
No recomendado: menor seguridad |
Ejemplo
A continuación se muestra un ejemplo que crea una tabla, inserta una fila y la lee de nuevo. La única diferencia respecto a una aplicación estándar de Go con MySQL es el nombre del controlador (encmysql) y los parámetros MEK y ENC_ALGO en el DSN.
Inicialice el proyecto:
go mod init demo
go get github.com/aliyun/alibabacloud-encdb-mysql-go-client@latest
main.go:
package main
import (
"database/sql"
"fmt"
"log"
_ "github.com/aliyun/alibabacloud-encdb-mysql-go-client"
)
func main() {
dsn := "<username>:<password>@tcp(<hostname>:<port>)/<dbname>?MEK=00112233445566778899aabbccddeeff&ENC_ALGO=SM4_128_CBC"
db, err := sql.Open("encmysql", dsn)
if err != nil {
log.Fatal("failed to open connection:", err)
}
defer db.Close()
if err = db.Ping(); err != nil {
log.Fatal("failed to reach database:", err)
}
_, err = db.Exec("DROP TABLE IF EXISTS test")
if err != nil {
log.Fatal(err)
}
_, err = db.Exec("CREATE TABLE test (a INT, b TEXT, c FLOAT)")
if err != nil {
log.Fatal(err)
}
_, err = db.Exec("INSERT INTO test SET a = 0, b = 'test', c = 0.0")
if err != nil {
log.Fatal(err)
}
rows, err := db.Query("SELECT * FROM test")
if err != nil {
log.Fatal(err)
}
defer rows.Close()
rows.Next()
var a int
var b string
var c float32
if err = rows.Scan(&a, &b, &c); err != nil {
log.Fatal(err)
}
fmt.Printf("read data: %d %s %f\n", a, b, c)
}
Reemplace los marcadores de posición de conexión con los datos reales de su clúster. Después de ejecutar el código, obtendrá el siguiente resultado:
read data: 0 test 0.000000
Esto confirma que el controlador descifró los datos y los devolvió en texto plano.
Pasos siguientes
Configure reglas de cifrado adicionales en la consola de PolarDB para proteger columnas específicas.
Almacene su MEK en un servicio de gestión de claves (KMS) o en un administrador de secretos, en lugar de codificarla directamente en su aplicación.
Revise always-confidential feature documentation para conocer cómo configurar reglas de cifrado a nivel de columna.