2020-08-09 22:29:54 +00:00
|
|
|
|
// Copyright 2016 Google Inc. All rights reserved.
|
|
|
|
|
// Use of this source code is governed by a BSD-style
|
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
|
|
|
|
|
package uuid
|
|
|
|
|
|
|
|
|
|
import "io"
|
|
|
|
|
|
|
|
|
|
// New creates a new random UUID or panics. New is equivalent to
|
|
|
|
|
// the expression
|
|
|
|
|
//
|
|
|
|
|
// uuid.Must(uuid.NewRandom())
|
|
|
|
|
func New() UUID {
|
|
|
|
|
return Must(NewRandom())
|
|
|
|
|
}
|
|
|
|
|
|
2021-10-16 21:11:32 +00:00
|
|
|
|
// NewString creates a new random UUID and returns it as a string or panics.
|
|
|
|
|
// NewString is equivalent to the expression
|
|
|
|
|
//
|
|
|
|
|
// uuid.New().String()
|
|
|
|
|
func NewString() string {
|
|
|
|
|
return Must(NewRandom()).String()
|
|
|
|
|
}
|
|
|
|
|
|
2020-08-09 22:29:54 +00:00
|
|
|
|
// NewRandom returns a Random (Version 4) UUID.
|
|
|
|
|
//
|
|
|
|
|
// The strength of the UUIDs is based on the strength of the crypto/rand
|
|
|
|
|
// package.
|
|
|
|
|
//
|
2021-12-11 23:05:15 +00:00
|
|
|
|
// Uses the randomness pool if it was enabled with EnableRandPool.
|
|
|
|
|
//
|
2020-08-09 22:29:54 +00:00
|
|
|
|
// A note about uniqueness derived from the UUID Wikipedia entry:
|
|
|
|
|
//
|
|
|
|
|
// Randomly generated UUIDs have 122 random bits. One's annual risk of being
|
|
|
|
|
// hit by a meteorite is estimated to be one chance in 17 billion, that
|
|
|
|
|
// means the probability is about 0.00000000006 (6 × 10−11),
|
|
|
|
|
// equivalent to the odds of creating a few tens of trillions of UUIDs in a
|
|
|
|
|
// year and having one duplicate.
|
|
|
|
|
func NewRandom() (UUID, error) {
|
2021-12-11 23:05:15 +00:00
|
|
|
|
if !poolEnabled {
|
|
|
|
|
return NewRandomFromReader(rander)
|
|
|
|
|
}
|
|
|
|
|
return newRandomFromPool()
|
2020-12-31 13:48:12 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// NewRandomFromReader returns a UUID based on bytes read from a given io.Reader.
|
|
|
|
|
func NewRandomFromReader(r io.Reader) (UUID, error) {
|
2020-08-09 22:29:54 +00:00
|
|
|
|
var uuid UUID
|
2020-12-31 13:48:12 +00:00
|
|
|
|
_, err := io.ReadFull(r, uuid[:])
|
2020-08-09 22:29:54 +00:00
|
|
|
|
if err != nil {
|
|
|
|
|
return Nil, err
|
|
|
|
|
}
|
|
|
|
|
uuid[6] = (uuid[6] & 0x0f) | 0x40 // Version 4
|
|
|
|
|
uuid[8] = (uuid[8] & 0x3f) | 0x80 // Variant is 10
|
|
|
|
|
return uuid, nil
|
|
|
|
|
}
|
2021-12-11 23:05:15 +00:00
|
|
|
|
|
|
|
|
|
func newRandomFromPool() (UUID, error) {
|
|
|
|
|
var uuid UUID
|
|
|
|
|
poolMu.Lock()
|
|
|
|
|
if poolPos == randPoolSize {
|
|
|
|
|
_, err := io.ReadFull(rander, pool[:])
|
|
|
|
|
if err != nil {
|
|
|
|
|
poolMu.Unlock()
|
|
|
|
|
return Nil, err
|
|
|
|
|
}
|
|
|
|
|
poolPos = 0
|
|
|
|
|
}
|
|
|
|
|
copy(uuid[:], pool[poolPos:(poolPos+16)])
|
|
|
|
|
poolPos += 16
|
|
|
|
|
poolMu.Unlock()
|
|
|
|
|
|
|
|
|
|
uuid[6] = (uuid[6] & 0x0f) | 0x40 // Version 4
|
|
|
|
|
uuid[8] = (uuid[8] & 0x3f) | 0x80 // Variant is 10
|
|
|
|
|
return uuid, nil
|
|
|
|
|
}
|