Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gofrs/uuid
A UUID package for Go
https://github.com/gofrs/uuid
forked-repo go uuid uuid-generator uuid1 uuid2 uuid3 uuid4 uuid5
Last synced: 6 days ago
JSON representation
A UUID package for Go
- Host: GitHub
- URL: https://github.com/gofrs/uuid
- Owner: gofrs
- License: mit
- Created: 2018-07-13T02:13:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-23T21:20:45.000Z (20 days ago)
- Last Synced: 2025-01-04T07:42:16.325Z (9 days ago)
- Topics: forked-repo, go, uuid, uuid-generator, uuid1, uuid2, uuid3, uuid4, uuid5
- Language: Go
- Homepage:
- Size: 321 KB
- Stars: 1,597
- Watchers: 21
- Forks: 113
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- go-awesome - gofrs/uuid
- awesome-go - uuid - Implementation of Universally Unique Identifier (UUID). Supports both creation and parsing of UUIDs. Actively maintained fork of satori uuid. Stars:`1.6K`. (UUID / Utility/Miscellaneous)
- awesome-go - uuid - A UUID package originally forked from github.com/satori/go.uuid - ★ 325 (Miscellaneous)
- awesome-go-extra - uuid - 07-13T02:13:28Z|2022-06-06T04:48:41Z| (UUID / Fail injection)
- awesome-go-zh - uuid
README
# UUID
[](https://github.com/gofrs/uuid/blob/master/LICENSE)
[](https://github.com/gofrs/uuid/actions/workflows/go.yml)
[](https://pkg.go.dev/github.com/gofrs/uuid/v5)
[](https://codecov.io/gh/gofrs/uuid/)
[](https://goreportcard.com/report/github.com/gofrs/uuid)
[](https://github.com/gofrs/uuid/actions/workflows/codeql.yml)
[](https://www.bestpractices.dev/projects/8929)
[](https://scorecard.dev/viewer/?uri=github.com/gofrs/uuid)
Package uuid provides a pure Go implementation of Universally Unique Identifiers
(UUID) variant as defined in RFC-9562. This package supports both the creation
and parsing of UUIDs in different formats.
This package supports the following UUID versions:
* Version 1, based on timestamp and MAC address
* Version 3, based on MD5 hashing of a named value
* Version 4, based on random numbers
* Version 5, based on SHA-1 hashing of a named value
* Version 6, a k-sortable id based on timestamp, and field-compatible with v1
* Version 7, a k-sortable id based on timestamp
## Project History
This project was originally forked from the
[github.com/satori/go.uuid](https://github.com/satori/go.uuid) repository after
it appeared to be no longer maintained, while exhibiting [critical
flaws](https://github.com/satori/go.uuid/issues/73). We have decided to take
over this project to ensure it receives regular maintenance for the benefit of
the larger Go community.
We'd like to thank Maxim Bublis for his hard work on the original iteration of
the package.
## License
This source code of this package is released under the MIT License. Please see
the [LICENSE](https://github.com/gofrs/uuid/blob/master/LICENSE) for the full
content of the license.
## Recommended Package Version
We recommend using v2.0.0+ of this package, as versions prior to 2.0.0 were
created before our fork of the original package and have some known
deficiencies.
## Requirements
This package requires Go 1.19 or later
## Usage
Here is a quick overview of how to use this package. For more detailed
documentation, please see the [GoDoc Page](http://godoc.org/github.com/gofrs/uuid).
```go
package main
import (
"log"
"github.com/gofrs/uuid/v5"
)
// Create a Version 4 UUID, panicking on error.
// Use this form to initialize package-level variables.
var u1 = uuid.Must(uuid.NewV4())
func main() {
// Create a Version 4 UUID.
u2, err := uuid.NewV4()
if err != nil {
log.Fatalf("failed to generate UUID: %v", err)
}
log.Printf("generated Version 4 UUID %v", u2)
// Parse a UUID from a string.
s := "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
u3, err := uuid.FromString(s)
if err != nil {
log.Fatalf("failed to parse UUID %q: %v", s, err)
}
log.Printf("successfully parsed UUID %v", u3)
}
```
## References
* [RFC-9562](https://tools.ietf.org/html/rfc9562) (replaces RFC-4122)
* [DCE 1.1: Authentication and Security Services](http://pubs.opengroup.org/onlinepubs/9696989899/chap5.htm#tagcjh_08_02_01_01)