sanitize

README

go-sanitize

Simple library of sanitation methods for data sanitation and reduction

Table of Contents

• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Installation

go-sanitize requires a supported release of Go.

go get -u github.com/mrz1836/go-sanitize

Documentation

View the generated documentation

Library Deployment

goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

all                    Runs multiple commands
clean                  Remove previous builds and any test cache data
clean-mods             Remove all the Go mod cache
coverage               Shows the test coverage
godocs                 Sync the latest tag with GoDocs
help                   Show this help message
install                Install the application
install-go             Install the application (Using Native Go)
lint                   Run the golangci-lint application (install if not found)
release                Full production release (creates release in Github)
release                Runs common.release then runs godocs
release-snap           Test the full release (build binaries)
release-test           Full production test release (everything except deploy)
replace-version        Replaces the version in HTML/JS (pre-deploy)
tag                    Generate a new tag and push (tag version=0.0.0)
tag-remove             Remove a tag if found (tag-remove version=0.0.0)
tag-update             Update an existing tag to current commit (tag-update version=0.0.0)
test                   Runs vet, lint and ALL tests
test-short             Runs vet, lint and tests (excludes integration tests)
test-travis            Runs all tests via Travis (also exports coverage)
test-travis-short      Runs unit tests via Travis (also exports coverage)
uninstall              Uninstall the application (and remove files)
update-linter          Update the golangci-lint package (macOS only)
vet                    Run the Go vet application

Examples & Tests

All unit tests and examples run via Travis CI and uses Go version 1.15.x. View the deployment configuration file.

Run all tests (including any integration tests)

make test

Benchmarks

Run the Go benchmarks:

make bench

Code Standards

Read more about this Go project's code standards.

Usage

• View the examples
• View the benchmarks
• View the tests

Basic implementation:

package main

import (
    "fmt"
    
    "github.com/mrz1836/go-sanitize"
)

func main() {

	// Execute and print
	fmt.Println(sanitize.IPAddress("  ##!192.168.0.1!##  "))

	// Output: 192.168.0.1
}

Maintainers

MrZ

Contributing

View the contributing guidelines and please follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀

License

Documentation

Overview

Package sanitize (go-sanitize) implements a simple library of various sanitation methods for data transformation.

If you have any suggestions or comments, please feel free to open an issue on this project's GitHub page.

Index

• func Alpha(original string, spaces bool) string
• func AlphaNumeric(original string, spaces bool) string
• func BitcoinAddress(original string) string
• func BitcoinCashAddress(original string) string
• func Custom(original string, regExp string) string
• func Decimal(original string) string
• func Domain(original string, preserveCase bool, removeWww bool) (string, error)
• func Email(original string, preserveCase bool) string
• func FirstToUpper(original string) string
• func FormalName(original string) string
• func HTML(original string) string
• func IPAddress(original string) string
• func Numeric(original string) string
• func PathName(original string) string
• func Punctuation(original string) string
• func Scripts(original string) string
• func SingleLine(original string) string
• func Time(original string) string
• func URI(original string) string
• func URL(original string) string
• func XML(original string) string
• func XSS(original string) string

Examples

• Alpha
• Alpha (WithSpaces)
• AlphaNumeric
• AlphaNumeric (WithSpaces)
• BitcoinAddress
• BitcoinCashAddress
• Custom
• Custom (Numeric)
• Decimal
• Decimal (Negative)
• Domain
• Domain (PreserveCase)
• Domain (RemoveWww)
• Email
• Email (PreserveCase)
• FirstToUpper
• FormalName
• HTML
• IPAddress
• IPAddress (Ipv6)
• Numeric
• PathName
• Punctuation
• Scripts
• SingleLine
• Time
• URI
• URL
• XML
• XSS

Functions

func Alpha

func Alpha(original string, spaces bool) string

Alpha returns only alpha characters. Set the parameter spaces to true if you want to allow space characters. Valid characters are a-z and A-Z.

View examples: sanitize_test.go

Example

ExampleAlpha example using Alpha() and no spaces flag

fmt.Println(Alpha("Example String!", false))

Output:

ExampleString

Example (WithSpaces)

ExampleAlpha_withSpaces example using Alpha with spaces flag

fmt.Println(Alpha("Example String!", true))

Output:

Example String

func AlphaNumeric

func AlphaNumeric(original string, spaces bool) string

AlphaNumeric returns only alphanumeric characters. Set the parameter spaces to true if you want to allow space characters. Valid characters are a-z, A-Z and 0-9.

View examples: sanitize_test.go

Example

ExampleAlphaNumeric example using AlphaNumeric() with no spaces

fmt.Println(AlphaNumeric("Example String 2!", false))

Output:

ExampleString2

Example (WithSpaces)

ExampleAlphaNumeric_withSpaces example using AlphaNumeric() with spaces

fmt.Println(AlphaNumeric("Example String 2!", true))

Output:

Example String 2

func BitcoinAddress

func BitcoinAddress(original string) string

BitcoinAddress returns sanitized value for bitcoin address

View examples: sanitize_test.go

Example

ExampleBitcoinAddress example using BitcoinAddress()

fmt.Println(BitcoinAddress(":1K6c7LGpdB8LwoGNVfG51dRV9UUEijbrWs!"))

Output:

1K6c7LGpdB8LwoGNVfG51dRV9UUEijbrWs

func BitcoinCashAddress

func BitcoinCashAddress(original string) string

BitcoinCashAddress returns sanitized value for bitcoin `cashaddr` address (https://www.bitcoinabc.org/2018-01-14-CashAddr/)

View examples: sanitize_test.go

Example

ExampleBitcoinCashAddress example using BitcoinCashAddress() `cashaddr`

fmt.Println(BitcoinAddress("qze7yy2au5vuznvn8lzj5y0j5t066vhs75e3m0eptz!"))

Output:

qze7yy2au5vuznvn8zj5yj5t66vhs75e3meptz

func Custom

func Custom(original string, regExp string) string

Custom uses a custom regex string and returns the sanitized result. This is used for any additional regex that this package does not contain.

View examples: sanitize_test.go

Example

ExampleCustom example using Custom() using an alpha regex

fmt.Println(Custom("Example String 2!", `[^a-zA-Z]`))

Output:

ExampleString

Example (Numeric)

ExampleCustom_numeric example using Custom() using a numeric regex

fmt.Println(Custom("Example String 2!", `[^0-9]`))

Output:

2

func Decimal

func Decimal(original string) string

Decimal returns sanitized decimal/float values in either positive or negative.

View examples: sanitize_test.go

Example

ExampleDecimal example using Decimal() for a positive number

fmt.Println(Decimal("$ 99.99!"))

Output:

99.99

Example (Negative)

ExampleDecimal_negative example using Decimal() for a negative number

fmt.Println(Decimal("$ -99.99!"))

Output:

-99.99

func Domain

func Domain(original string, preserveCase bool, removeWww bool) (string, error)

Domain returns a proper hostname / domain name. Preserve case is to flag keeping the case versus forcing to lowercase. Use the removeWww flag to strip the www sub-domain. This method returns an error if parse critically fails.

View examples: sanitize_test.go

Example

ExampleDomain example using Domain()

fmt.Println(Domain("https://www.Example.COM/?param=value", false, false))

Output:

www.example.com <nil>

Example (PreserveCase)

ExampleDomain_preserveCase example using Domain() and preserving the case

fmt.Println(Domain("https://www.Example.COM/?param=value", true, false))

Output:

www.Example.COM <nil>

Example (RemoveWww)

ExampleDomain_removeWww example using Domain() and removing the www sub-domain

fmt.Println(Domain("https://www.Example.COM/?param=value", false, true))

Output:

example.com <nil>

func Email

func Email(original string, preserveCase bool) string

Email returns a sanitized email address string. Email addresses are forced to lowercase and removes any mail-to prefixes.

View examples: sanitize_test.go

Example

ExampleEmail example using Email()

fmt.Println(Email("mailto:Person@Example.COM", false))

Output:

person@example.com

Example (PreserveCase)

ExampleEmail_preserveCase example using Email() and preserving the case

fmt.Println(Email("mailto:Person@Example.COM", true))

Output:

Person@Example.COM

func FirstToUpper

func FirstToUpper(original string) string

FirstToUpper overwrites the first letter as an uppercase letter and preserves the rest of the string.

View examples: sanitize_test.go

Example

ExampleFirstToUpper example using FirstToUpper()

fmt.Println(FirstToUpper("this works"))

Output:

This works

func FormalName

func FormalName(original string) string

FormalName returns a formal name or surname (for First, Middle and Last)

View examples: sanitize_test.go

Example

ExampleFormalName example using FormalName()

fmt.Println(FormalName("John McDonald Jr.!"))

Output:

John McDonald Jr.

func HTML

func HTML(original string) string

HTML returns a string without any <HTML> tags.

View examples: sanitize_test.go

Example

ExampleHTML example using HTML()

fmt.Println(HTML("<body>This Works?</body>"))

Output:

This Works?

func IPAddress

func IPAddress(original string) string

IPAddress returns an ip address for both ipv4 and ipv6 formats.

View examples: sanitize_test.go

Example

ExampleIPAddress example using IPAddress() for IPV4 address

fmt.Println(IPAddress(" 192.168.0.1 "))

Output:

192.168.0.1

Example (Ipv6)

ExampleIPAddress_ipv6 example using IPAddress() for IPV6 address

fmt.Println(IPAddress(" 2602:305:bceb:1bd0:44ef:fedb:4f8f:da4f "))

Output:

2602:305:bceb:1bd0:44ef:fedb:4f8f:da4f

func Numeric

func Numeric(original string) string

Numeric returns numbers only.

View examples: sanitize_test.go

Example

ExampleNumeric example using Numeric()

fmt.Println(Numeric("This:123 + 90!"))

Output:

12390

func PathName

func PathName(original string) string

PathName returns a formatted path compliant name.

View examples: sanitize_test.go

Example

ExampleNumeric example using PathName()

fmt.Println(PathName("/This-Works_Now-123/!"))

Output:

This-Works_Now-123

func Punctuation

func Punctuation(original string) string

Punctuation returns a string with basic punctuation preserved.

View examples: sanitize_test.go

Example

ExamplePunctuation example using Punctuation()

fmt.Println(Punctuation(`[@"Does" 'this' work?@] this too`))

Output:

"Does" 'this' work? this too

func Scripts

func Scripts(original string) string

Scripts removes all scripts, iframes and embeds tags from string.

View examples: sanitize_test.go

Example

ExampleScripts example using Scripts()

fmt.Println(Scripts(`Does<script>This</script>Work?`))

Output:

DoesWork?

func SingleLine

func SingleLine(original string) string

SingleLine returns a single line string, removes all carriage returns.

View examples: sanitize_test.go

Example

ExampleSingleLine example using SingleLine()

fmt.Println(SingleLine(`Does
This
Work?`))

Output:

Does This Work?

func Time

func Time(original string) string

Time returns just the time part of the string.

View examples: sanitize_test.go

Example

ExampleTime example using Time()

fmt.Println(Time(`Time 01:02:03!`))

Output:

01:02:03

func URI

func URI(original string) string

URI returns allowed URI characters only.

View examples: sanitize_test.go

Example

ExampleURI example using URI()

fmt.Println(URI("/This/Works?^No&this"))

Output:

/This/Works?No&this

func URL

func URL(original string) string

URL returns a formatted url friendly string.

View examples: sanitize_test.go

Example

ExampleURL example using URL()

fmt.Println(URL("https://Example.com/This/Works?^No&this"))

Output:

https://Example.com/This/Works?No&this

func XML

func XML(original string) string

XML returns a string without any <XML> tags - alias of HTML.

View examples: sanitize_test.go

Example

ExampleXML example using XML()

fmt.Println(XML("<xml>This?</xml>"))

Output:

This?

func XSS

func XSS(original string) string

XSS removes known XSS attack strings or script strings.

View examples: sanitize_test.go

Example

ExampleXSS example using XSS()

fmt.Println(XSS("<script>This?</script>"))

Output:

>This?</