spring_password_encoder

README

go-spring-password-encoder

Spring compatible password encoders written in golang

Usage

Add entry to go.mod file:

[...]

go 1.16

require (
    github.com/cbuschka/go-spring-password-encoder v1.0.0
    [...]
)

import the package fromn within your code:

import "github.com/cbuschka/go-spring-password-encoder"

SHA256PasswordEncoder (called StandardPasswordEncoder by spring)

Hint: This password encoder is considered legacy and too weak.

Hash and encode password

encoder := spring_password_encoder.NewDefaultSHA256PasswordEncoder()

encodedPasswordHash, err := encoder.Encode("asdfasdf")

Compare plain text password with hashed password

encoder := spring_password_encoder.NewDefaultSHA256PasswordEncoder()

encodedPasswordHash, err := encoder.Encode("asdfasdf")

See sha256 password encoder test

BCryptPasswordEncoder

Hash and encode password

encoder := spring_password_encoder.NewDefaultBCryptPasswordEncoder()

encodedPasswordHash, err := encoder.Encode("asdfasdf")

Compare plain text password with hashed password

encoder := spring_password_encoder.NewDefaultBCryptPasswordEncoder()

encodedPasswordHash, err := encoder.Encode("asdfasdf")

See bcrypt password encoder test

License

Copyright (c) 2021 by Cornelius Buschka.

Apache License, Version 2.0

Documentation

Index

• type BCryptPasswordEncoder
  • func (encoder *BCryptPasswordEncoder) Encode(plainPassword string) (string, error)
  • func (encoder *BCryptPasswordEncoder) Matches(plainPassword string, encodedPasswordHash string) (bool, error)
• type PasswordEncoder
  • func NewBCryptPasswordEncoder(strength int) PasswordEncoder
  • func NewDefaultBCryptPasswordEncoder() PasswordEncoder
  • func NewDefaultSHA256PasswordEncoder() PasswordEncoder
  • func NewSHA256PasswordEncoder(saltLengthBytes int, iterations int) PasswordEncoder
• type SHA256PasswordEncoder
  • func (encoder *SHA256PasswordEncoder) Encode(plainPassword string) (string, error)
  • func (encoder *SHA256PasswordEncoder) Matches(plainPassword string, encodedPasswordHash string) (bool, error)

Types

type BCryptPasswordEncoder

type BCryptPasswordEncoder struct {
	// contains filtered or unexported fields
}

BCryptPasswordEncoder is compatible to spring's BCryptPasswordEncoder.

func (*BCryptPasswordEncoder) Encode

func (encoder *BCryptPasswordEncoder) Encode(plainPassword string) (string, error)

func (*BCryptPasswordEncoder) Matches

func (encoder *BCryptPasswordEncoder) Matches(plainPassword string, encodedPasswordHash string) (bool, error)

type PasswordEncoder

type PasswordEncoder interface {
	Matches(plainPassword string, encodedPasswordHash string) (bool, error)

	Encode(plainPassword string) (string, error)
}

PasswordEncoder is the interface to password encoding and matching

func NewBCryptPasswordEncoder

func NewBCryptPasswordEncoder(strength int) PasswordEncoder

func NewDefaultBCryptPasswordEncoder

func NewDefaultBCryptPasswordEncoder() PasswordEncoder

func NewDefaultSHA256PasswordEncoder

func NewDefaultSHA256PasswordEncoder() PasswordEncoder

NewDefaultSHA256PasswordEncoder creates a SHA256 password encoder with default params

func NewSHA256PasswordEncoder

func NewSHA256PasswordEncoder(saltLengthBytes int, iterations int) PasswordEncoder

NewSHA256PasswordEncoder creates a SHA256 password encoder

type SHA256PasswordEncoder

type SHA256PasswordEncoder struct {
	// contains filtered or unexported fields
}

SHA256PasswordEncoder is compatible to spring's StandardPasswordEncoder.

func (*SHA256PasswordEncoder) Encode

func (encoder *SHA256PasswordEncoder) Encode(plainPassword string) (string, error)

func (*SHA256PasswordEncoder) Matches

func (encoder *SHA256PasswordEncoder) Matches(plainPassword string, encodedPasswordHash string) (bool, error)

Matches checks if password is the same as an encoded password hash has been created from