Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #90 from letsencrypt/85-relational_db_in_ca
Add Relational DB support to CA (Issue #85)
- Loading branch information
Showing
10 changed files
with
377 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright 2015 ISRG. All rights reserved | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
|
|
||
| package ca | ||
|
|
||
| import ( | ||
| "database/sql" | ||
| "errors" | ||
| "time" | ||
|
|
||
| "github.com/letsencrypt/boulder/core" | ||
| blog "github.com/letsencrypt/boulder/log" | ||
| ) | ||
|
|
||
| // CertificateAuthorityDatabaseImpl represents a database used by the CA; it | ||
| // enforces transaction semantics, and is effectively single-threaded. | ||
| type CertificateAuthorityDatabaseImpl struct { | ||
| log *blog.AuditLogger | ||
| db *sql.DB | ||
| activeTx *sql.Tx | ||
| } | ||
|
|
||
| // NewCertificateAuthorityDatabaseImpl constructs a Database for the | ||
| // Certificate Authority. | ||
| func NewCertificateAuthorityDatabaseImpl(logger *blog.AuditLogger, driver string, name string) (cadb core.CertificateAuthorityDatabase, err error) { | ||
| if logger == nil { | ||
| err = errors.New("Nil logger not permitted") | ||
| return | ||
| } | ||
|
|
||
| db, err := sql.Open(driver, name) | ||
| if err != nil { | ||
| return | ||
| } | ||
| if err = db.Ping(); err != nil { | ||
| return | ||
| } | ||
|
|
||
| cadb = &CertificateAuthorityDatabaseImpl{ | ||
| db: db, | ||
| log: logger, | ||
| } | ||
|
|
||
| err = createTablesIfNotExist(db) | ||
| return | ||
| } | ||
|
|
||
| // createTablesIfNotExist builds the database tables and inserts the initial | ||
| // state, if the tables do not already exist. It is not an error for the tables | ||
| // to already exist. | ||
| func createTablesIfNotExist(db *sql.DB) (err error) { | ||
| tx, err := db.Begin() | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| // Create serial number table | ||
| _, err = tx.Exec("CREATE TABLE serialNumber (id INTEGER, number INTEGER, lastUpdated DATETIME);") | ||
| if err != nil { | ||
| // If the table exists, exit early | ||
| tx.Rollback() | ||
| return nil | ||
| } | ||
|
|
||
| // Initialize the serial number | ||
| _, err = tx.Exec("INSERT INTO serialNumber (id, number, lastUpdated) VALUES (1, 1, ?);", time.Now()) | ||
| if err != nil { | ||
| tx.Rollback() | ||
| return | ||
| } | ||
|
|
||
| err = tx.Commit() | ||
| return | ||
| } | ||
|
|
||
| // Begin starts a Database transaction. There can only be one in this object | ||
| // at a time. | ||
| func (cadb *CertificateAuthorityDatabaseImpl) Begin() (err error) { | ||
| if cadb.activeTx != nil { | ||
| err = errors.New("Transaction already open") | ||
| return | ||
| } | ||
| cadb.activeTx, err = cadb.db.Begin() | ||
| return | ||
| } | ||
|
|
||
| // Commit makes permanent a database transaction; there must be an active | ||
| // transaction when called. | ||
| func (cadb *CertificateAuthorityDatabaseImpl) Commit() (err error) { | ||
| if cadb.activeTx == nil { | ||
| err = errors.New("Transaction already closed") | ||
| return | ||
| } | ||
| err = cadb.activeTx.Commit() | ||
| cadb.activeTx = nil | ||
| return | ||
| } | ||
|
|
||
| // Rollback cancels the ongoing database transaction; there must be an active | ||
| // transaction when called. | ||
| func (cadb *CertificateAuthorityDatabaseImpl) Rollback() (err error) { | ||
| if cadb.activeTx == nil { | ||
| err = errors.New("Transaction already closed") | ||
| return | ||
| } | ||
| err = cadb.activeTx.Rollback() | ||
| cadb.activeTx = nil | ||
| return | ||
| } | ||
|
|
||
| // IncrementAndGetSerial returns the next-available serial number, incrementing | ||
| // it in the database before returning. There must be an active transaction to | ||
| // call this method. Callers should Begin the transaction, call this method, | ||
| // perform any other work, and Commit at the end once the certificate is issued. | ||
| func (cadb *CertificateAuthorityDatabaseImpl) IncrementAndGetSerial() (val int, err error) { | ||
| if cadb.activeTx == nil { | ||
| err = errors.New("No transaction open") | ||
| return | ||
| } | ||
|
|
||
| row := cadb.activeTx.QueryRow("SELECT number FROM serialNumber LIMIT 1;") | ||
|
|
||
| err = row.Scan(&val) | ||
| if err != nil { | ||
| cadb.activeTx.Rollback() | ||
| return | ||
| } | ||
|
|
||
| val = val + 1 | ||
|
|
||
| _, err = cadb.activeTx.Exec("UPDATE serialNumber SET number=?, lastUpdated=? WHERE id=1", val, time.Now()) | ||
| if err != nil { | ||
| cadb.activeTx.Rollback() | ||
| return | ||
| } | ||
|
|
||
| return | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| // Copyright 2015 ISRG. All rights reserved | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
|
|
||
| package ca | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| _ "github.com/letsencrypt/boulder/Godeps/_workspace/src/github.com/mattn/go-sqlite3" | ||
| blog "github.com/letsencrypt/boulder/log" | ||
| "github.com/letsencrypt/boulder/test" | ||
| ) | ||
|
|
||
| const badDriver = "nothing" | ||
| const badFilename = "/doesnotexist/nofile" | ||
| const sqliteDriver = "sqlite3" | ||
| const sqliteName = ":memory:" | ||
|
|
||
| func TestConstruction(t *testing.T) { | ||
| log, err := blog.Dial("", "", "tag") | ||
| test.AssertNotError(t, err, "Could not construct audit logger") | ||
|
|
||
| // Successful case | ||
| _, err = NewCertificateAuthorityDatabaseImpl(log, sqliteDriver, sqliteName) | ||
| test.AssertNotError(t, err, "Could not construct CA DB") | ||
|
|
||
| // Covers "sql.Open" error | ||
| _, err = NewCertificateAuthorityDatabaseImpl(log, badDriver, sqliteName) | ||
| test.AssertError(t, err, "Should have failed construction") | ||
|
|
||
| // Covers "db.Ping" error | ||
| _, err = NewCertificateAuthorityDatabaseImpl(log, sqliteDriver, badFilename) | ||
| test.AssertError(t, err, "Should have failed construction") | ||
|
|
||
| // Ensures no nil pointer exception in logging | ||
| _, err = NewCertificateAuthorityDatabaseImpl(nil, sqliteDriver, sqliteName) | ||
| test.AssertError(t, err, "Should have failed construction") | ||
| } | ||
|
|
||
| func TestBeginCommit(t *testing.T) { | ||
| log, err := blog.Dial("", "", "tag") | ||
| test.AssertNotError(t, err, "Could not construct audit logger") | ||
|
|
||
| cadb, err := NewCertificateAuthorityDatabaseImpl(log, sqliteDriver, sqliteName) | ||
| test.AssertNotError(t, err, "Could not construct CA DB") | ||
|
|
||
| err = cadb.Begin() | ||
| test.AssertNotError(t, err, "Could not begin") | ||
|
|
||
| err = cadb.Begin() | ||
| test.AssertError(t, err, "Should have already begun") | ||
|
|
||
| err = cadb.Commit() | ||
| test.AssertNotError(t, err, "Could not commit") | ||
|
|
||
| err = cadb.Commit() | ||
| test.AssertError(t, err, "Should have already committed") | ||
|
|
||
| } | ||
|
|
||
| func TestGetSetSequenceOutsideTx(t *testing.T) { | ||
| log, err := blog.Dial("", "", "tag") | ||
| test.AssertNotError(t, err, "Could not construct audit logger") | ||
|
|
||
| cadb, err := NewCertificateAuthorityDatabaseImpl(log, sqliteDriver, sqliteName) | ||
| test.AssertNotError(t, err, "Could not construct CA DB") | ||
|
|
||
| _, err = cadb.IncrementAndGetSerial() | ||
| test.AssertError(t, err, "Not permitted") | ||
| } | ||
|
|
||
| func TestGetSetSequenceNumber(t *testing.T) { | ||
| log, err := blog.Dial("", "", "tag") | ||
| test.AssertNotError(t, err, "Could not construct audit logger") | ||
|
|
||
| cadb, err := NewCertificateAuthorityDatabaseImpl(log, sqliteDriver, sqliteName) | ||
| test.AssertNotError(t, err, "Could not construct CA DB") | ||
|
|
||
| err = cadb.Begin() | ||
| test.AssertNotError(t, err, "Could not begin") | ||
|
|
||
| num, err := cadb.IncrementAndGetSerial() | ||
| test.AssertNotError(t, err, "Could not get number") | ||
|
|
||
| num2, err := cadb.IncrementAndGetSerial() | ||
| test.AssertNotError(t, err, "Could not get number") | ||
| test.Assert(t, num+1 == num2, "Numbers should be incrementing") | ||
|
|
||
| err = cadb.Commit() | ||
| test.AssertNotError(t, err, "Could not commit") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.