lucsky/cuid

Collision-resistant hashes for the cloud, in Go

cuid

Collision-resistant hashes for the cloud, in Go.

The cuid package provides collision-resistant ids optimized for horizontal scaling and sequential lookup performance. This README file is just going to cover the basics and the Go-specific implementation details.

Please refer to the main project site for the full rationale behind CUIDs.

Sample CUID

ch72gsb320000udocl363eofy

Sample CUID Slug

ew0k9fwpl

Installation

go get -u github.com/lucsky/cuid

Example usage

package main

import (
    "crypto/rand"
    "fmt"

    "github.com/lucsky/cuid"
)

func main() {
    // Generate pseudo-random CUID
    fmt.Println(cuid.New())
    // Generate slug
    fmt.Println(cuid.Slug())

    // Generate cryptographic-random CUID
    c, err := cuid.NewCrypto(rand.Reader)
    if err != nil {
        fmt.Printf("%v", err)
        return
    }
    fmt.Println(c)
}

Go package specific features

The Go cuid package provides APIs to specify a custom random source as well as a custom counter. A custom counter implementation could provide a centralized Redis base counter, for example.

Contributors

• Luc Heinrich (@lucsky, author)
• Thomas Hopkins (@hopkinsth)
• fiatjaf
• Marcus Dantas (@mpsdantas)
• Oscar Forner Martinez (@maitesin)
• Mike Frey (@mikefrey)
• Andris Mednis (@andrismednis)

cuid's Issues

Proposal: Please start using Semantic Versioning

I found that this project already supports Go modules. The latest version v1.2 committed on 29 Oct 2019, the last version which followed Semantic Versioning is v1.0.2, committed on 25 Aug 2018. If module user run "go get github.com/lucsky/cuid", the old version v1.0.2 will be required.

$go get github.com/lucsky/cuid
go: downloading github.com/lucsky/cuid v1.0.2
go: github.com/lucsky/cuid upgrade => v1.0.2

So, I propose this project to follow Semantic Versioning in future versions. For example, v1.0.1, v2.0.0, v3.1.0-alpha, v3.1.0-beta.2etc, so that other project can use tag in go.mod.

cuid.Slug()

Is this something we want in this library? (I know I do)

Cuid standard is deprecated.

Due to security concerns (which also exist in database auto-increment ids, uuid/guid, and most other id standrads), the Cuid standard is now deprecated in favor of Cuid2.

time.Now().Unix() vs. time.Now().UnixNano()

Hi,

I noticed at lines https://github.com/lucsky/cuid/blob/master/cuid.go#L27 and https://github.com/lucsky/cuid/blob/master/cuid.go#L58 you used time.Now().Unix(). I've seen in other examples people using time.Now().UnixNano(). Just curious as to why you chose not to use time.Now().UnixNano()?

Thanks
Frank