icecore-hashids

A lightweight generator for short, unique, non-sequential and decodable Hashids from non-negative numbers.

License	Apache License, Version 2.0
GroupId	com.arcticicestudio
ArtifactId	icecore-hashids
Last Version	0.4.0
Release Date	Aug 13, 2017
Type	jar
Description	icecore-hashids A lightweight generator for short, unique, non-sequential and decodable Hashids from non-negative numbers.
Project URL	https://github.com/arcticicestudio/icecore-hashids
Project Organization	Arctic Ice Studio
Source Code Management	https://github.com/arcticicestudio/icecore-hashids

Download icecore-hashids

Filename	Size
icecore-hashids-0.4.0.pom
icecore-hashids-0.4.0.jar	8 KB
icecore-hashids-0.4.0-sources.jar	10 KB
icecore-hashids-0.4.0-javadoc.jar	38 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.arcticicestudio/icecore-hashids/ -->
<dependency>
    <groupId>com.arcticicestudio</groupId>
    <artifactId>icecore-hashids</artifactId>
    <version>0.4.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.arcticicestudio/icecore-hashids/
implementation 'com.arcticicestudio:icecore-hashids:0.4.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.arcticicestudio/icecore-hashids/
implementation ("com.arcticicestudio:icecore-hashids:0.4.0")

Apache Buildr

'com.arcticicestudio:icecore-hashids:jar:0.4.0'

Apache Ivy

<dependency org="com.arcticicestudio" name="icecore-hashids" rev="0.4.0">
  <artifact name="icecore-hashids" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.arcticicestudio', module='icecore-hashids', version='0.4.0')
)

Scala SBT

libraryDependencies += "com.arcticicestudio" % "icecore-hashids" % "0.4.0"

Leiningen

[com.arcticicestudio/icecore-hashids "0.4.0"]

Dependencies

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.12
org.hamcrest : hamcrest-junit	jar	2.0.0.0

Project Modules

There are no modules declared in this project.

---

A lightweight generator for short, unique, non-sequential and decodable Hashids from non-negative numbers.

Implementation of the Hashids algorithm.

Hashids are obfuscated unique hashes of non-negative (long) integer numbers, but in contrast to cryptographic one-way hash algorithms they are can be decoded again. The algorithm can be used to either generate a hash from a single number or bundling several numbers into one to be stored as simple short UIDs. This design allows to use them for many use-cases like

• URL shortening
• database ID protection
• shard numbers storage
• invitation-, authorization- and gift codes
• complex- or clustered system parameters

Numbers like 347 are converted into strings like yr8, or an array of numbers like [27, 986] into 3kTMd.

Features

The algorithm provides the following features:

• Generation of short, unique, case-sensitive and non-sequential decodable hashes of natural numbers
• Additional entropy through salt usage
• Configurable minimum hash length and alphabet
• Combining of several numbers to one hash
• Deterministic hash computation given the same input and parametrization/instance configuration
• Prevention of curse words through separator characters

In addition, the library provides features to

• pass 0x or 0X prefixed hexadecimal numbers to the public API methods
• handle exceptions instead of returning empty values when invalid parameters are passed to any public API method
• disable the maximum number size limit which ensures the interoperability with the algorithm reference implementation and allows the usage of the Java Long maximum value

Please note that most features will break the interoperability with the algorithm reference implementation!

Getting Started

The project documentation contains chapters to learn about the installation and requirements, get an overview of the API and learn how to use it, and build the project and running the tests.

Contributing

Read the contributing guide to learn about the development process and how to propose enhancement suggestions and report bugs, how to submit pull requests and the project's styleguides, branch organization and versioning model.

The guide also includes information about minimal, complete, and verifiable examples and other ways to contribute to the project like improving existing issues and giving feedback on issues and pull requests.

---

Copyright © 2016-present Arctic Ice Studio

Versions

Version
0.4.0 Aug 13, 2017
0.3.0 Jul 17, 2017
0.2.0 Oct 16, 2016