README
¶
Wiz Repository
This project collects generic sample go code, which can be used to accelerate other projects.
import gitlab.com/AMPK/wiz
wiz.Out("Charging my laser...")
wiz.Success("Summoning was successful")
What's Here
Each file is a cluster of utility functions under a single theme:
- Argon.go = Argon2 password hashing (create hash, and check match)
- ArgonHashPassword(pw string) (string, error)
- ArgonCheckPassword(pw string, hash string) bool
- Client.go = Makes basic HTTP GET and POST requests. Can also send and receive structs directly with JSON.
- Get(url string) ([]byte, error)
- Post(url string, requestBody []byte) ([]byte, error)
- StructGet(url string, responsePayload interface{}) error
- StructPost(burl string, requestPayload interface{}, responsePayload interface{}) error
- Console.go = Prints colored text to the console. Prompts for user input. Includes silent (password) input.
- SilentPrompt(prompt string) string
- Prompt(prompt string) string
- Warning(bold string, a ...interface{})
- Success(bold string, a ...interface{})
- Out(a ...interface{})
- Ed25519.go = Ed25519 Elliptic Curve Cryptography. (Public key) Lighter than RSA. More secure than ECDSA (see file).
- NewEdKeyPair(seed []byte) ([]byte, []byte, error)
- EdSign(data []byte, privateKey []byte, publicKey []byte) ([]byte, error)
- EdVerify(data []byte, signature []byte, publicKey []byte) error
- Files.go = Read and write to files, or make directories, from your code.
- DeleteFile(file string) error
- MkDir(dir string) error
- WriteFile(file string, data []byte) error
- ReadFile(file string) ([]byte, error)
- Hash.go = SHA3-512 hash function and shortcut 'does the hash match' function.
- Hash(data []byte) []byte
- HashMatch(data []byte, hash []byte) bool
- Hex.go = Convert bytes to uppercase hexadecimal strings and back.
- BytesToHex(data []byte) string
- HexToBytes(data string) ([]byte, error)
- JSON.go = Convert data items in go (e.g. structs) to JSON. Also formats neatly.
- MarshalNeat(payload interface{}) ([]byte, error)
- StringMarshalNeat(payload interface{}) (string, error)
- MarshalNeatMatch(data []byte, prototype interface{}) error
- Random.go = Generate random bytes.
- RandomBytes(len int) ([]byte, error)
- SQLite.go = Create and use SQLite databases, specifically for simple key=INT, value=STRING tables
- type Database struct
- SQLiteOpen(dbName string) (Database, error)
- Database.Close()
- Database.MakeTable(tableName string) error
- Database.ClearTable(tableName string) error
- Database.AddItemAt(tableName string, primaryKey uint64, data string) error
- Database.GetItemAt(tableName string, primaryKey uint64) (string, error)
- Database.DeleteItemAt(tableName string, primaryKey uint64) error
- Database.GetKeys(tableName string) ([]uint64, error)
- Database.CheckOrder(tableName string) (uint64, error)
- Server.go = Respond to incoming HTTP requests by passing them to the handler functions you pass.
- Serve(addr string, getter func([]string) (int, []byte), poster func([]string, []byte) (int, []byte)) (string, error)
- Sleep.go = Pause thread execution
- Sleep(n int)
- Time.go = Get the current unix time
- Now() uint64
Why use this?
It's a collection of shortcut utilities all under one import. Make stuff faster with it.
Also it makes good example code to cannibalize.
Organization
Each file is named according to its primary function.
Each file contains a mini-readme at the top.
Author's policy: Each file must stand alone, so they can each be pasted into another project without breaking. Regrettably this approach makes mixing functionality (like using [JSON file] MarshalNeat in [Client file] StructPost) a no-go for me.
Files shall be arranged in the following order:
- Imports
- Constants & Variables
- Exposed functions
- Supporting functions
All functions will return structured errors whenever errors are returned, using github.com/pkg/errors (notably errors.Wrap and errors.New)
License
CC0 1.0
The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law.
You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
Credits
- Developer: Adam Moser https://gitlab.com/AMPK
- Project Avatar: https://pixabay.com/photos/clothes-clothing-costume-trick-2874/
Documentation
¶
Index ¶
- Constants
- func ArgonCheckPassword(pw string, hash string) bool
- func ArgonHashPassword(pw string) (string, error)
- func BytesToHex(data []byte) string
- func DeleteFile(file string) error
- func EdSign(data []byte, privateKey []byte, publicKey []byte) ([]byte, error)
- func EdVerify(data []byte, signature []byte, publicKey []byte) error
- func Get(url string) ([]byte, error)
- func Hash(data []byte) []byte
- func HashMatch(data []byte, hash []byte) bool
- func HexToBytes(data string) ([]byte, error)
- func MarshalNeat(payload interface{}) ([]byte, error)
- func MarshalNeatMatch(data []byte, prototype interface{}) error
- func MkDir(dir string) error
- func NewEdKeyPair(seed []byte) ([]byte, []byte, error)
- func Now() uint64
- func Out(a ...interface{})
- func Post(url string, requestBody []byte) ([]byte, error)
- func Prompt(prompt string) string
- func RandomBytes(len int) ([]byte, error)
- func ReadFile(file string) ([]byte, error)
- func Serve(addr string, getter func([]string) (int, []byte), ...) (string, error)
- func SilentPrompt(prompt string) string
- func Sleep(n int)
- func SplitURL(url string) []string
- func StringMarshalNeat(payload interface{}) (string, error)
- func StructGet(url string, responsePayload interface{}) error
- func StructPost(url string, requestPayload interface{}, responsePayload interface{}) error
- func Success(bold string, a ...interface{})
- func Warning(bold string, a ...interface{})
- func WriteFile(file string, data []byte) error
- type Database
- func (db *Database) AddItemAt(tableName string, primaryKey uint64, data string) error
- func (db *Database) CheckOrder(tableName string) (uint64, error)
- func (db *Database) ClearTable(tableName string) error
- func (db *Database) Close()
- func (db *Database) DeleteItemAt(tableName string, primaryKey uint64) error
- func (db *Database) GetItemAt(tableName string, primaryKey uint64) (string, error)
- func (db *Database) GetKeys(tableName string) ([]uint64, error)
- func (db *Database) MakeTable(tableName string) error
Constants ¶
const ( PublicKeySize = 32 PrivateKeySize = 64 SeedSize = 32 )
Variables ¶
This section is empty.
Functions ¶
func ArgonCheckPassword ¶
func ArgonHashPassword ¶
func BytesToHex ¶
BytesToHex Converts byte slice to string representation (hexadecimal).
func DeleteFile ¶
DeleteFile deletes a file (or empty directory) at a location
func HashMatch ¶
HashMatch checks if the SHA3-512 of a given byte slice matches a given 64 byte array
func HexToBytes ¶
HexToBytes Converts string to byte slice if it is valid hexadecimal. Slice length is zero on fail.
func MarshalNeat ¶
func MarshalNeatMatch ¶
func Out ¶
func Out(a ...interface{})
Prints grey / "Faint white". Spaces, not newlines, between items passed.
func RandomBytes ¶
RandomBytes returns byte slice of length n filled with random data
func SilentPrompt ¶
Displays a prompt to the interface and returns what the user enters. Hides user input from the console. Use for password entry for example.
func StringMarshalNeat ¶
func StructPost ¶
func Success ¶
func Success(bold string, a ...interface{})
Prints green. The first item passed is bolded. Each item gets a new line.
Types ¶
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
func SQLiteOpen ¶
func (*Database) CheckOrder ¶
If your database is expected to have items at primary keys [1,2,3,4...] then this function will return the next open key following that order. Error is nil only if all (non-zero, non-negative) keys were in order with no gaps between them. IGNORES NEGATIVE AND ZERO KEYS.
Source Files