1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
|
package nssdb
import (
"context"
"crypto/sha1" //nolint:gosec // NSS uses sha1
"database/sql"
"errors"
"fmt"
"os"
"path/filepath"
"strings"
"time"
_ "modernc.org/sqlite" // enable sql driver
"go.step.sm/crypto/internal/utils"
)
var columnNames = make(map[string]string, len(columns))
func init() {
for k, v := range columns {
columnNames[v] = k
}
}
type NSSDB struct {
Key *sql.DB
Cert *sql.DB
columns []string
colTable map[string]bool
// aka "intermediate key", this is derived from the user-provided password and
// the "global salt" in the metaData. This is used as input to pbkdf2 for all
// encryption and signing operations.
passKey []byte
emptyPassword bool
}
func (db *NSSDB) Close() error {
if err := db.Key.Close(); err != nil {
return fmt.Errorf("close key db: %w", err)
}
if err := db.Cert.Close(); err != nil {
return fmt.Errorf("close cert db: %w", err)
}
return nil
}
// New opens connections to the cert9 and key4 sqlite databases in the provided
// directory. It defaults to the current directory if not set. The password
// argument is not required if the NSS database was created with the
// --empty-password flag.
func New(dir string, pw []byte) (*NSSDB, error) {
if dir == "" {
dir = "."
}
keyfile := filepath.Join(dir, "key4.db")
certfile := filepath.Join(dir, "cert9.db")
if _, err := os.Stat(keyfile); err != nil {
return nil, fmt.Errorf("no nss database found in %q", dir)
}
if _, err := os.Stat(certfile); err != nil {
return nil, fmt.Errorf("no nss database found in %q", dir)
}
keydb, err := sql.Open("sqlite", "file:"+keyfile)
if err != nil {
return nil, fmt.Errorf("open keydb %q: %w", keyfile, err)
}
certdb, err := sql.Open("sqlite", "file:"+certfile)
if err != nil {
return nil, fmt.Errorf("open certdb %q: %w", certfile, err)
}
// For backward and forward compatibility we need to know what columns are in
// the nssPrivate and nssPublic tables. They share the same schema.
rows, err := certdb.Query("SELECT * FROM nssPublic LIMIT 0")
if err != nil {
return nil, err
}
defer rows.Close()
var dbcolumns []string
colTable := map[string]bool{}
cols, err := rows.ColumnTypes()
if err != nil {
return nil, err
}
if err := rows.Err(); err != nil {
return nil, err
}
for _, col := range cols {
name := col.Name()
if _, ok := columnNames[name]; !ok {
// ignore any unknown columns
continue
}
dbcolumns = append(dbcolumns, name)
colTable[name] = true
}
var globalSalt []byte
err = keydb.QueryRow(`SELECT item1 FROM metaData WHERE id = 'password'`).Scan(&globalSalt)
if err != nil {
return nil, fmt.Errorf("get salt from metaData table in key db: %w", err)
}
return &NSSDB{
Key: keydb,
Cert: certdb,
columns: dbcolumns,
colTable: colTable,
passKey: intermediateKey(pw, globalSalt),
}, nil
}
// https://github.com/nss-dev/nss/blob/NSS_3_107_RTM/lib/softoken/sftkpwd.c#L89
func intermediateKey(password, salt []byte) []byte {
//nolint:gosec // NSS uses sha1
h := sha1.New()
h.Write(salt)
h.Write(password)
return h.Sum(nil)
}
// ListObjects fetches all objects in the nssPublic and nssPrivate tables.
func (db *NSSDB) ListObjects(ctx context.Context) ([]*Object, error) {
pubObjs, err := db.ListObjectsPublic(ctx)
if err != nil {
return nil, err
}
privateObjs, err := db.ListObjectsPrivate(ctx)
if err != nil {
return nil, err
}
return append(privateObjs, pubObjs...), nil
}
// ListObjectsPublic fetches all objects in the nssPublic table in the cert db.
func (db *NSSDB) ListObjectsPublic(ctx context.Context) ([]*Object, error) {
//nolint:gosec // trusted strings
q := fmt.Sprintf("SELECT id, %s FROM nssPublic", strings.Join(db.columns, ", "))
rows, err := db.Cert.QueryContext(ctx, q)
if err != nil {
return nil, err
}
return db.scanObjects(ctx, rows, false)
}
// ListObjectPrivate fetches all rows in the nssPrivate table in the key db.
func (db *NSSDB) ListObjectsPrivate(ctx context.Context) ([]*Object, error) {
//nolint:gosec // trusted strings
q := fmt.Sprintf("SELECT id, %s FROM nssPrivate", strings.Join(db.columns, ", "))
rows, err := db.Key.QueryContext(ctx, q)
if err != nil {
return nil, err
}
return db.scanObjects(ctx, rows, false)
}
// GetObject fetches a single object by id from either the nssPublic table in the cert db
// or the nssPrivate table in the key db if not found in nssPublic.
func (db *NSSDB) GetObject(ctx context.Context, id uint32) (*Object, error) {
obj, err := db.GetObjectPublic(ctx, id)
if err != nil && !errors.Is(err, sql.ErrNoRows) {
return nil, err
}
if err == nil {
return obj, nil
}
return db.GetObjectPrivate(ctx, id)
}
// GetObjectPublic fetches a single object by id from the nssPublic table in the cert db.
func (db *NSSDB) GetObjectPublic(ctx context.Context, id uint32) (*Object, error) {
//nolint:gosec // trusted strings
q := fmt.Sprintf("SELECT id, %s FROM nssPublic WHERE id = ?", strings.Join(db.columns, ", "))
rows, err := db.Cert.QueryContext(ctx, q, id)
if err != nil {
return nil, err
}
return db.scanObject(ctx, rows, false)
}
// GetObjectPrivate fetches a single object by id from the nssPrivate table in
// the key db.
func (db *NSSDB) GetObjectPrivate(ctx context.Context, id uint32) (*Object, error) {
//nolint:gosec // trusted strings
q := fmt.Sprintf("SELECT id, %s FROM nssPrivate WHERE id = ?", strings.Join(db.columns, ", "))
rows, err := db.Key.QueryContext(ctx, q, id)
if err != nil {
return nil, err
}
obj, err := db.scanObject(ctx, rows, true)
if err != nil {
return nil, err
}
for k, v := range obj.EncryptedAttributes {
plaintext, err := db.decrypt(v)
if err != nil {
return nil, fmt.Errorf("decrypt %s: %w", k, err)
}
obj.Attributes[k] = plaintext
}
return obj, nil
}
// InsertPublic adds an object to the nssPublic table of the cert db.
func (db *NSSDB) InsertPublic(ctx context.Context, obj *Object) (uint32, error) {
id, err := db.getObjectID(ctx)
if err != nil {
return 0, fmt.Errorf("get new object id: %w", err)
}
obj.ID = id
if err := db.insert(ctx, obj, false); err != nil {
return 0, err
}
return id, nil
}
// InsertPrivate adds an object to the nssPrivate table of the key db.
func (db *NSSDB) InsertPrivate(ctx context.Context, obj *Object) (uint32, error) {
id, err := db.getObjectID(ctx)
if err != nil {
return 0, fmt.Errorf("get new object id: %w", err)
}
obj.ID = id
obj.EncryptedAttributes = map[string][]byte{}
for k, plaintext := range obj.Attributes {
if !privateAttributes[k] {
continue
}
encrypted, err := db.encrypt(plaintext)
if err != nil {
return 0, fmt.Errorf("encrypt %s: %w", k, err)
}
obj.EncryptedAttributes[k] = encrypted
metadata, err := db.sign(id, plaintext)
if err != nil {
return 0, err
}
obj.Metadata = append(obj.Metadata, metadata)
}
if err := db.insert(ctx, obj, true); err != nil {
return 0, err
}
return id, nil
}
func (db *NSSDB) insert(ctx context.Context, obj *Object, private bool) error {
cols := []string{"id"}
vals := []any{obj.ID}
params := []string{"?"}
for name, data := range obj.Attributes {
if _, ok := obj.EncryptedAttributes[name]; ok {
// insert the encrypted value, not the plaintext value
continue
}
col := columns[name]
if _, ok := db.colTable[col]; !ok {
return fmt.Errorf("db does not have a column for %q", name)
}
cols = append(cols, col)
vals = append(vals, data)
params = append(params, "?")
}
for name, data := range obj.EncryptedAttributes {
col := columns[name]
if _, ok := db.colTable[col]; !ok {
return fmt.Errorf("db does not have a column for %q", name)
}
cols = append(cols, col)
vals = append(vals, data)
params = append(params, "?")
}
for name, u := range obj.ULongAttributes {
col := columns[name]
if _, ok := db.colTable[col]; !ok {
return fmt.Errorf("db does not have a column for %q", name)
}
cols = append(cols, col)
vals = append(vals, encodeDBUlong(u))
params = append(params, "?")
}
certTx, err := db.Cert.BeginTx(ctx, nil)
if err != nil {
return err
}
defer certTx.Rollback()
keyTx, err := db.Key.BeginTx(ctx, nil)
if err != nil {
return err
}
defer keyTx.Rollback()
if private {
//nolint:gosec // trusted strings
q := fmt.Sprintf("INSERT INTO nssPrivate (%s) VALUES (%s)", strings.Join(cols, ", "), strings.Join(params, ", "))
if _, err := keyTx.ExecContext(ctx, q, vals...); err != nil {
return err
}
} else {
//nolint:gosec // trusted strings
q := fmt.Sprintf("INSERT INTO nssPublic (%s) VALUES (%s)", strings.Join(cols, ", "), strings.Join(params, ", "))
if _, err := certTx.ExecContext(ctx, q, vals...); err != nil {
return err
}
}
for _, metadata := range obj.Metadata {
const q = "INSERT INTO metaData (id, item1, item2) VALUES (?, ?, ?)"
if _, err := keyTx.ExecContext(ctx, q, metadata.ID, metadata.Item1, metadata.Item2); err != nil {
return err
}
}
if err := keyTx.Commit(); err != nil {
return err
}
if err := certTx.Commit(); err != nil {
return err
}
return nil
}
// Delete deletes an object.
func (db *NSSDB) DeleteObject(ctx context.Context, id uint32) error {
if err := db.DeleteObjectPublic(ctx, id); err != nil {
return err
}
if err := db.DeleteObjectPrivate(ctx, id); err != nil {
return err
}
return nil
}
// DeletePublic deletes an object from the nssPublic database in the cert db.
func (db *NSSDB) DeleteObjectPublic(ctx context.Context, id uint32) error {
_, err := db.Cert.ExecContext(ctx, "DELETE FROM nssPublic WHERE id = ?", id)
return err
}
// DeletePrivate deletes an object from the nssPrivate database in the key db.
func (db *NSSDB) DeleteObjectPrivate(ctx context.Context, id uint32) error {
_, err := db.Key.ExecContext(ctx, "DELETE FROM nssPrivate WHERE id = ?", id)
if err != nil {
return err
}
err = db.deleteSignatures(ctx, id)
if err != nil {
return fmt.Errorf("delete object metadata: %w", err)
}
return nil
}
// Reset deletes all objects and their metadata from the certificate and key
// databases. It does not delete the password from the metaData table.
func (db *NSSDB) Reset(ctx context.Context) error {
certTx, err := db.Cert.BeginTx(ctx, nil)
if err != nil {
return nil
}
defer certTx.Rollback()
keyTx, err := db.Key.BeginTx(ctx, nil)
if err != nil {
return nil
}
defer keyTx.Rollback()
_, err = certTx.ExecContext(ctx, "DELETE FROM nssPublic")
if err != nil {
return err
}
_, err = keyTx.ExecContext(ctx, "DELETE FROM nssPrivate")
if err != nil {
return err
}
_, err = keyTx.ExecContext(ctx, `DELETE FROM metaData WHERE id <> "password"`)
if err != nil {
return err
}
if err := certTx.Commit(); err != nil {
return err
}
if err := keyTx.Commit(); err != nil {
return err
}
return nil
}
func (db *NSSDB) scanObject(ctx context.Context, rows *sql.Rows, private bool) (*Object, error) {
objects, err := db.scanObjects(ctx, rows, private)
if err != nil {
return nil, err
}
if len(objects) == 0 {
return nil, sql.ErrNoRows
}
return objects[0], nil
}
func (db *NSSDB) scanObjects(ctx context.Context, rows *sql.Rows, private bool) ([]*Object, error) {
objects := []*Object{}
for rows.Next() {
object, err := db.scan(ctx, rows, private)
if err != nil {
return nil, err
}
objects = append(objects, object)
}
if err := rows.Err(); err != nil {
return nil, err
}
return objects, nil
}
func (db *NSSDB) scan(ctx context.Context, rows *sql.Rows, private bool) (*Object, error) {
row := &Object{
Attributes: map[string][]byte{},
ULongAttributes: map[string]uint32{},
EncryptedAttributes: map[string][]byte{},
}
dest := make([]any, len(db.columns)+1)
id := sql.NullInt64{}
dest[0] = &id
for i := range db.columns {
dest[i+1] = &sql.Null[[]byte]{}
}
err := rows.Scan(dest...)
if err != nil {
return nil, err
}
for i, dst := range dest[1:] {
col := db.columns[i]
name := columnNames[col]
b := dst.(*sql.Null[[]byte])
if b.Valid {
data := b.V
if _, ok := ulongAttributes[name]; ok {
row.ULongAttributes[name] = decodeDBUlong(data)
} else if _, ok := privateAttributes[name]; ok && private {
// private attributes are only encrypted in nssPrivate in the key db
row.EncryptedAttributes[name] = data
} else {
row.Attributes[name] = data
}
}
}
u32ID, err := utils.SafeUint32(id.Int64)
if err != nil {
return nil, fmt.Errorf("failed converting %d to uint32: %w", id.Int64, err)
}
row.ID = u32ID
if _, ok := row.EncryptedAttributes["CKA_VALUE"]; ok {
ckaValSignatureID := keySignatureID(row.ID)
md, err := db.GetMetadata(ctx, ckaValSignatureID)
switch {
case errors.Is(err, sql.ErrNoRows):
case err != nil:
return nil, err
default:
row.Metadata = append(row.Metadata, md)
}
}
return row, nil
}
// https://github.com/nss-dev/nss/blob/NSS_3_107_RTM/lib/softoken/sdb.c#L1260
func (db *NSSDB) getObjectID(ctx context.Context) (uint32, error) {
id, err := utils.SafeUint32(time.Now().Unix() & 0x3fffffff)
if err != nil {
return 0, fmt.Errorf("failed converting timestamp to uint32: %w", err)
}
for i := 0; i < 0x40000000; i++ {
id &= 0x3fffffff
if id == 0 {
continue
}
_, err := db.GetObject(ctx, id)
switch {
case errors.Is(err, sql.ErrNoRows):
return id, nil
case err != nil:
return 0, err
}
id++
}
return 0, errors.New("no id available")
}
// findByAttr returns ids of objects having the specified attribute value.
func (db *NSSDB) findByAttr(ctx context.Context, ckaClass uint32, name string, val []byte) ([]uint32, error) {
col := columns[name]
if !db.colTable[col] {
return nil, fmt.Errorf("this nss db does not have a column for the attribute %q", name)
}
var rows *sql.Rows
var err error
switch ckaClass {
case CKO_PRIVATE_KEY:
//nolint:gosec // trusted column name
q := fmt.Sprintf("SELECT id FROM nssPrivate WHERE %s = ? AND a0 = ? AND id IS NOT NULL", col)
rows, err = db.Key.QueryContext(ctx, q, val, encodeDBUlong(CKO_PRIVATE_KEY))
case CKO_PUBLIC_KEY:
//nolint:gosec // trusted column name
q := fmt.Sprintf("SELECT id FROM nssPublic WHERE %s = ? AND a0 = ? AND id IS NOT NULL", col)
rows, err = db.Cert.QueryContext(ctx, q, val, encodeDBUlong(CKO_PUBLIC_KEY))
case CKO_CERTIFICATE:
//nolint:gosec // trusted column name
q := fmt.Sprintf("SELECT id FROM nssPublic WHERE %s = ? AND a0 = ? AND a80 = ? AND id IS NOT NULL", col)
rows, err = db.Cert.QueryContext(ctx, q, val, encodeDBUlong(CKO_CERTIFICATE), encodeDBUlong(CKC_X_509))
default:
return nil, fmt.Errorf("unsupported class %d", ckaClass)
}
if err != nil {
return nil, err
}
defer rows.Close()
var ids []uint32
for rows.Next() {
var id uint32
if err := rows.Scan(&id); err != nil {
return nil, err
}
ids = append(ids, id)
}
if err := rows.Err(); err != nil {
return nil, err
}
return ids, nil
}
|