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
|
package storage
import (
"crypto/sha256"
"encoding/hex"
"fmt"
"strconv"
"time"
"github.com/go-sql-driver/mysql"
"github.com/jinzhu/gorm"
"github.com/lib/pq"
"github.com/sirupsen/logrus"
"github.com/theupdateframework/notary/tuf/data"
)
// SQLStorage implements a versioned store using a relational database.
// See server/storage/models.go
type SQLStorage struct {
*gorm.DB
}
// NewSQLStorage is a convenience method to create a SQLStorage
func NewSQLStorage(dialect string, args ...interface{}) (*SQLStorage, error) {
gormDB, err := gorm.Open(dialect, args...)
if err != nil {
return nil, err
}
return &SQLStorage{
DB: gormDB,
}, nil
}
// translateOldVersionError captures DB errors, and attempts to translate
// duplicate entry
func translateOldVersionError(err error) error {
switch err := err.(type) {
case *mysql.MySQLError:
// https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
// 1022 = Can't write; duplicate key in table '%s'
// 1062 = Duplicate entry '%s' for key %d
if err.Number == 1022 || err.Number == 1062 {
return ErrOldVersion{}
}
case *pq.Error:
// https://www.postgresql.org/docs/10/errcodes-appendix.html
// 23505 = unique_violation
if err.Code == "23505" {
return ErrOldVersion{}
}
}
return err
}
// UpdateCurrent updates a single TUF.
func (db *SQLStorage) UpdateCurrent(gun data.GUN, update MetaUpdate) error {
// ensure we're not inserting an immediately old version - can't use the
// struct, because that only works with non-zero values, and Version
// can be 0.
exists := db.Where("gun = ? and role = ? and version >= ?",
gun.String(), update.Role.String(), update.Version).Take(&TUFFile{})
if exists.Error == nil {
return ErrOldVersion{}
} else if !exists.RecordNotFound() {
return exists.Error
}
// only take out the transaction once we're about to start writing
tx, rb, err := db.getTransaction()
if err != nil {
return err
}
checksum := sha256.Sum256(update.Data)
hexChecksum := hex.EncodeToString(checksum[:])
if err := func() error {
// write new TUFFile entry
if err = translateOldVersionError(tx.Create(&TUFFile{
Gun: gun.String(),
Role: update.Role.String(),
Version: update.Version,
SHA256: hexChecksum,
Data: update.Data,
}).Error); err != nil {
return err
}
// If we're publishing a timestamp, update the changefeed as this is
// technically an new version of the TUF repo
if update.Role == data.CanonicalTimestampRole {
if err := db.writeChangefeed(tx, gun, update.Version, hexChecksum); err != nil {
return err
}
}
return nil
}(); err != nil {
return rb(err)
}
return tx.Commit().Error
}
type rollback func(error) error
func (db *SQLStorage) getTransaction() (*gorm.DB, rollback, error) {
tx := db.Begin()
if tx.Error != nil {
return nil, nil, tx.Error
}
rb := func(err error) error {
if rxErr := tx.Rollback().Error; rxErr != nil {
logrus.Error("Failed on Tx rollback with error: ", rxErr.Error())
return rxErr
}
return err
}
return tx, rb, nil
}
// UpdateMany atomically updates many TUF records in a single transaction
func (db *SQLStorage) UpdateMany(gun data.GUN, updates []MetaUpdate) error {
if !allUpdatesUnique(updates) {
// We would fail with a unique constraint violation later, so just bail out now
return ErrOldVersion{}
}
minVersionsByRole := make(map[data.RoleName]int)
for _, u := range updates {
cur, ok := minVersionsByRole[u.Role]
if !ok || u.Version < cur {
minVersionsByRole[u.Role] = u.Version
}
}
for role, minVersion := range minVersionsByRole {
// If there are any files with version equal or higher than the minimum
// version we're trying to insert, bail out now
exists := db.Where("gun = ? and role = ? and version >= ?",
gun.String(), role.String(), minVersion).Take(&TUFFile{})
if exists.Error == nil {
return ErrOldVersion{}
} else if !exists.RecordNotFound() {
return exists.Error
}
}
tx, rb, err := db.getTransaction()
if err != nil {
return err
}
if err := func() error {
for _, update := range updates {
checksum := sha256.Sum256(update.Data)
hexChecksum := hex.EncodeToString(checksum[:])
result := tx.Create(&TUFFile{
Gun: gun.String(),
Role: update.Role.String(),
Version: update.Version,
Data: update.Data,
SHA256: hexChecksum,
})
if result.Error != nil {
return translateOldVersionError(result.Error)
}
if update.Role == data.CanonicalTimestampRole {
if err := db.writeChangefeed(tx, gun, update.Version, hexChecksum); err != nil {
return err
}
}
}
return nil
}(); err != nil {
return rb(err)
}
return tx.Commit().Error
}
func allUpdatesUnique(updates []MetaUpdate) bool {
type roleVersion struct {
Role data.RoleName
Version int
}
roleVersions := make(map[roleVersion]bool)
for _, u := range updates {
rv := roleVersion{u.Role, u.Version}
if roleVersions[rv] {
return false
}
roleVersions[rv] = true
}
return true
}
func (db *SQLStorage) writeChangefeed(tx *gorm.DB, gun data.GUN, version int, checksum string) error {
c := &SQLChange{
GUN: gun.String(),
Version: version,
SHA256: checksum,
Category: changeCategoryUpdate,
}
return tx.Create(c).Error
}
// GetCurrent gets a specific TUF record
func (db *SQLStorage) GetCurrent(gun data.GUN, tufRole data.RoleName) (*time.Time, []byte, error) {
var row TUFFile
q := db.Select("updated_at, data").Where(
&TUFFile{Gun: gun.String(), Role: tufRole.String()}).Order("version desc").Take(&row)
if err := isReadErr(q, row); err != nil {
return nil, nil, err
}
return &(row.UpdatedAt), row.Data, nil
}
// GetChecksum gets a specific TUF record by its hex checksum
func (db *SQLStorage) GetChecksum(gun data.GUN, tufRole data.RoleName, checksum string) (*time.Time, []byte, error) {
var row TUFFile
q := db.Select("created_at, data").Where(
&TUFFile{
Gun: gun.String(),
Role: tufRole.String(),
SHA256: checksum,
},
).Take(&row)
if err := isReadErr(q, row); err != nil {
return nil, nil, err
}
return &(row.CreatedAt), row.Data, nil
}
// GetVersion gets a specific TUF record by its version
func (db *SQLStorage) GetVersion(gun data.GUN, tufRole data.RoleName, version int) (*time.Time, []byte, error) {
var row TUFFile
q := db.Select("created_at, data").Where(
&TUFFile{
Gun: gun.String(),
Role: tufRole.String(),
Version: version,
},
).Take(&row)
if err := isReadErr(q, row); err != nil {
return nil, nil, err
}
return &(row.CreatedAt), row.Data, nil
}
func isReadErr(q *gorm.DB, row TUFFile) error {
if q.RecordNotFound() {
return ErrNotFound{}
} else if q.Error != nil {
return q.Error
}
return nil
}
// Delete deletes all the records for a specific GUN - we have to do a hard delete using Unscoped
// otherwise we can't insert for that GUN again
func (db *SQLStorage) Delete(gun data.GUN) error {
tx, rb, err := db.getTransaction()
if err != nil {
return err
}
if err := func() error {
res := tx.Unscoped().Where(&TUFFile{Gun: gun.String()}).Delete(TUFFile{})
if err := res.Error; err != nil {
return err
}
// if there weren't actually any records for the GUN, don't write
// a deletion change record.
if res.RowsAffected == 0 {
return nil
}
c := &SQLChange{
GUN: gun.String(),
Category: changeCategoryDeletion,
}
return tx.Create(c).Error
}(); err != nil {
return rb(err)
}
return tx.Commit().Error
}
// CheckHealth asserts that the tuf_files table is present
func (db *SQLStorage) CheckHealth() (err error) {
defer func() {
if r := recover(); r != nil {
err = fmt.Errorf("panic checking db health: %v", r)
}
}()
tableOk := db.HasTable(&TUFFile{})
if db.Error != nil {
return db.Error
}
if !tableOk {
return fmt.Errorf(
"cannot access table: %s", TUFFile{}.TableName())
}
return nil
}
// GetChanges returns up to pageSize changes starting from changeID.
func (db *SQLStorage) GetChanges(changeID string, records int, filterName string) ([]Change, error) {
var (
changes []Change
query = db.DB
id int64
err error
)
if changeID == "" {
id = 0
} else {
id, err = strconv.ParseInt(changeID, 10, 32)
if err != nil {
return nil, ErrBadQuery{msg: fmt.Sprintf("change ID expected to be integer, provided ID was: %s", changeID)}
}
}
// do what I mean, not what I said, i.e. if I passed a negative number for the ID
// it's assumed I mean "start from latest and go backwards"
reversed := id < 0
if records < 0 {
reversed = true
records = -records
}
if filterName != "" {
query = query.Where("gun = ?", filterName)
}
if reversed {
if id > 0 {
// only set the id check if we're not starting from "latest"
query = query.Where("id < ?", id)
}
query = query.Order("id desc")
} else {
query = query.Where("id > ?", id).Order("id asc")
}
res := query.Limit(records).Find(&changes)
if res.Error != nil {
return nil, res.Error
}
if reversed {
// results are currently newest to oldest, should be oldest to newest
for i, j := 0, len(changes)-1; i < j; i, j = i+1, j-1 {
changes[i], changes[j] = changes[j], changes[i]
}
}
return changes, nil
}
|