shsprintf

Documentation

Overview

Package shsprintf is a drop-in-replacement for using sprintf to produce shell scripts, that adds automatic detection for command / argument injection.

Index

• Variables
• func EscapeDefaultContext(in string) string
• func MustSprintf(format string, a ...any) string
• func Sprintf(format string, a ...any) (string, error)
• func SprintfLang(format string, lang syntax.LangVariant, a ...any) (string, error)

Variables

var ErrInvalidShTemplate error = errors.New("Invalid Shell Template")

ErrInvalidShTemplate indicates the requested template is not a valid script

var ErrShInjection error = errors.New("Shell Injection Detected")

ErrShInjection indicates the inputs resulted in shell injection.

Functions

func EscapeDefaultContext

func EscapeDefaultContext(in string) string

EscapeDefaultContext escapes special characters in a context where there is no existing quoting, such as --arg=%s

func MustSprintf

func MustSprintf(format string, a ...any) string

MustSprintf is a wrapper to Sprintf that panics upon error.

func Sprintf

func Sprintf(format string, a ...any) (string, error)

Sprintf is a fmt.Sprintf replacement specific for generating bash scripts, with protection against any string substitution from escaping its context, or from injecting new flag arguments.

func SprintfLang

func SprintfLang(format string, lang syntax.LangVariant, a ...any) (string, error)

SprintfLang is a fmt.Sprintf replacement specific for generating shell scripts, with protection against any string substitution from escaping its context, or from injecting new flag arguments.