added example and improved readme

phifty · phifty · commit 6e5d24ed2dea · 2018-01-24T12:30:14.000+01:00
diff --git a/README.md b/README.md
@@ -4,3 +4,39 @@
 [![Build Status](https://travis-ci.org/simia-tech/crypt.svg?branch=master)](https://travis-ci.org/simia-tech/crypt) [![Go Report Card](https://goreportcard.com/badge/github.com/simia-tech/crypt)](https://goreportcard.com/report/github.com/simia-tech/crypt)  [![Documentation](https://godoc.org/github.com/simia-tech/crypt?status.svg)](http://godoc.org/github.com/simia-tech/crypt)
 
 Crypt implementation in pure Go
+
+# Example
+
+```go
+func main() {
+	password := "password"
+	settings := "$argon2i$v=19$m=65536,t=2,p=4$c2FsdHNhbHQ" // salt = "saltsalt"
+
+	encoded, err := crypt.Crypt(password, settings)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	fmt.Println(encoded)
+	// Output: $argon2i$v=19$m=65536,t=2$c2FsdHNhbHQ$YPZdL78ZgqtxD1bLxAjRySEFfYb3Y1BOQQWFW6sT0Vo
+}
+```
+
+# Algorithm
+
+Currently, the following algorithms are supported
+
+| Code    | Name    | Example                                                                                              |
+|---------|---------|------------------------------------------------------------------------------------------------------|
+|       1 | MD5     | $1$$pL/BYSxMXs.jVuSV1lynn1                                                                           |
+|       5 | SHA256  | $5$saltstring$5B8vYYiY.CVt1RlTTf8KbXBH3hsxY/GNooZaBBGWEc5                                            |
+|       6 | SHA512  | $6$saltstring$svn8UoSVapNtMuq1ukKS4tPQd8iKwSMHWjl/O817G3uBnIFNjnQJuesI68u4OTLiBFdcbYEdFCoEOfaS35inz1 |
+| argon2i | Argon2i | $argon2i$v=19$m=65536,t=2$c29tZXNhbHQ$IMit9qkFULCMA/ViizL57cnTLOa5DiVM9eMwpAvPwr4                    |
+
+# Links
+
+This implementation is inspired by [crypt](https://github.com/GehirnInc/crypt).
+
+# License
+
+The code is licensed under [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
diff --git a/algorithm.go b/algorithm.go
@@ -1,11 +1,25 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 // Algorithm defines a algorithm.
-type Algorithm func (string, string) (string, error)
+type Algorithm func(string, string) (string, error)
 
 var algorithms = map[string]Algorithm{}
 
 // RegisterAlgorithm registers an algorithm under the provided prefix.
 func RegisterAlgorithm(prefix string, algorithm Algorithm) {
-  algorithms[prefix] = algorithm
+	algorithms[prefix] = algorithm
 }
diff --git a/argon2i.go b/argon2i.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 import (
diff --git a/argon2i_test.go b/argon2i_test.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt_test
 
 import (
diff --git a/base64.go b/base64.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 import "encoding/base64"
diff --git a/base64_test.go b/base64_test.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt_test
 
 import (
diff --git a/crypt.go b/crypt.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 import (
diff --git a/error.go b/error.go
diff --git a/example/simple/main.go b/example/simple/main.go
@@ -0,0 +1,35 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/simia-tech/crypt"
+)
+
+func main() {
+	password := "password"
+	settings := "$argon2i$v=19$m=65536,t=2,p=4$c2FsdHNhbHQ" // salt = "saltsalt"
+
+	encoded, err := crypt.Crypt(password, settings)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	fmt.Println(encoded)
+	// Output: $argon2i$v=19$m=65536,t=2$c2FsdHNhbHQ$YPZdL78ZgqtxD1bLxAjRySEFfYb3Y1BOQQWFW6sT0Vo
+}
diff --git a/md5.go b/md5.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 import (
diff --git a/md5_test.go b/md5_test.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt_test
 
 import (
diff --git a/settings.go b/settings.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 import (
diff --git a/settings_test.go b/settings_test.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt_test
 
 import (
diff --git a/sha256.go b/sha256.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 import (
diff --git a/sha256_test.go b/sha256_test.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt_test
 
 import (
diff --git a/sha512.go b/sha512.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 import (
diff --git a/sha512_test.go b/sha512_test.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt_test
 
 import (
diff --git a/util.go b/util.go
@@ -1,3 +1,17 @@
+// Copyright 2018 Philipp Brüll (pb@simia.tech)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package crypt
 
 const (
