dchest/uniuri

Go package uniuri generates random strings good for use in URIs to identify unique objects.

Package uniuri

import "github.com/dchest/uniuri"

Package uniuri generates random strings good for use in URIs to identify unique objects.

Example usage:

s := uniuri.New() // s is now "apHCJBl7L1OmC57n"

A standard string created by New() is 16 bytes in length and consists of Latin upper and lowercase letters, and numbers (from the set of 62 allowed characters), which means that it has ~95 bits of entropy. To get more entropy, you can use NewLen(UUIDLen), which returns 20-byte string, giving ~119 bits of entropy, or any other desired length.

Functions read from crypto/rand random source, and panic if they fail to read from it.

Constants

const (
	// StdLen is a standard length of uniuri string to achive ~95 bits of entropy.
	StdLen = 16
	// UUIDLen is a length of uniuri string to achive ~119 bits of entropy, closest
	// to what can be losslessly converted to UUIDv4 (122 bits).
	UUIDLen = 20
)

Variables

var StdChars = []byte("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789")

StdChars is a set of standard characters allowed in uniuri string.

Functions

func New

func New() string

New returns a new random string of the standard length, consisting of standard characters.

func NewLen

func NewLen(length int) string

NewLen returns a new random string of the provided length, consisting of standard characters.

func NewLenChars

func NewLenChars(length int, chars []byte) string

NewLenChars returns a new random string of the provided length, consisting of the provided byte slice of allowed characters (maximum 256).

Public domain dedication

Written in 2011-2014 by Dmitry Chestnykh

The author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. Distributed without any warranty. http://creativecommons.org/publicdomain/zero/1.0/

uniuri's Issues

Dependency relocated

See https://travis-ci.org/taskcluster/generic-worker/jobs/87917365#L143

Is this because uniuri is pointing to an old location of this dependency?

Add license

Could you please add a license under which "uniuri" is being distributed?

Shouldn't panic

As a third party library, you shouldn't invoke panic() but return an error and let the client deal with the error.

Add functions returning bytes

Hi, I want to avoid unnecessary memory allocation when using the library.
Would you mind break NewLenChars into another function retuning []byte?

LICENSE or COPYING file

It would be super helpful to include a LICENSE or COPYING file in your repo.

https://wiki.creativecommons.org/wiki/CC0_FAQ#May_I_apply_CC0_to_computer_software.3F_If_so.2C_is_there_a_recommended_implementation.3F

Recommends using:
https://creativecommons.org/publicdomain/zero/1.0/legalcode.txt

About the CC0 license

Since CC0 and public domain are not universally recognized formats for open-source code, would you be willing to license under MIT, Apache, BSD, or any of the OSI-approved licenses mentioned here?: https://opensource.org/licenses