open-vault/helper/base62/base62.go

// Package base62 provides utilities for working with base62 strings.
// base62 strings will only contain characters: 0-9, a-z, A-Z
package base62

import (
	"math/big"

	uuid "github.com/hashicorp/go-uuid"
)

// Encode converts buf into a base62 string
//
// Note: this should only be used for reducing a string's character set range.
// It is not for use with arbitrary data since leading 0 bytes will be dropped.
func Encode(buf []byte) string {
	var encoder big.Int

	encoder.SetBytes(buf)
	return encoder.Text(62)
}

// Decode converts input from base62 to its byte representation
// If the decoding fails, an empty slice is returned.
func Decode(input string) []byte {
	var decoder big.Int

	decoder.SetString(input, 62)
	return decoder.Bytes()
}

// Random generates a random base62-encoded string.
// If truncate is true, the result will be a string of the requested length.
// Otherwise, it will be the encoded result of length bytes of random data.
func Random(length int, truncate bool) (string, error) {
	bytesNeeded := length

	// ~0.74 bytes are needed per output character in truncate mode. We'll
	// ask for just a little more than that.
	if truncate {
		bytesNeeded = (bytesNeeded * 3 / 4) + 1
	}

	for {
		buf, err := uuid.GenerateRandomBytes(bytesNeeded)
		if err != nil {
			return "", err
		}

		result := Encode(buf)

		if truncate {
			if len(result) < length {
				continue
			}
			result = result[:length]
		}
		return result, nil
	}
}