Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6d3faa071e | |||
| 183ad41574 |
313
README.md
313
README.md
@@ -1,3 +1,312 @@
|
||||
# appcore
|
||||
# AppCore
|
||||
|
||||
go app core packages
|
||||
A comprehensive, production-ready Go utility library providing core functionality for building modern web applications.
|
||||
|
||||
[](https://go.dev/)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
## Overview
|
||||
|
||||
AppCore is a modular Go library that provides essential building blocks for web applications, with a focus on security, developer experience, and production reliability. The library offers reusable packages for common tasks including cryptography, email handling, JWT authentication, validation, and HTTP utilities.
|
||||
|
||||
## Features
|
||||
|
||||
- **Security-First Design**: Modern cryptography (ED25519, AES-GCM, Argon2id) following OWASP recommendations
|
||||
- **Type Safety**: Extensive use of Go generics and strong typing throughout
|
||||
- **Production Ready**: Comprehensive error handling and proper resource cleanup
|
||||
- **Developer Experience**: Convenient helper functions with consistent naming conventions
|
||||
- **Cross-Platform Support**: Works seamlessly across macOS, Linux, and Windows
|
||||
- **Modular Architecture**: Import only the packages you need
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go get code.patial.tech/go/appcore
|
||||
```
|
||||
|
||||
## Packages
|
||||
|
||||
### Security & Cryptography (`crypto`)
|
||||
|
||||
Password hashing, encryption, digital signatures, and secure random generation.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/crypto"
|
||||
|
||||
// Password hashing (Argon2id - OWASP compliant)
|
||||
hash, err := crypto.PasswordHash("mypassword")
|
||||
valid := crypto.ComparePasswordHash("mypassword", hash)
|
||||
|
||||
// AES-GCM encryption
|
||||
key := crypto.NewEncryptionKey(32)
|
||||
encrypted, err := crypto.Encrypt([]byte("data"), key)
|
||||
decrypted, err := crypto.Decrypt(encrypted, key)
|
||||
|
||||
// ED25519 key management
|
||||
privateKey, publicKey, err := crypto.NewPersistedED25519("./keys")
|
||||
|
||||
// Secure random generation
|
||||
randomBytes, err := crypto.RandomBytes(32)
|
||||
randomHex := crypto.RandomBytesHex(16)
|
||||
```
|
||||
|
||||
**Key Functions**: `MD5()`, `SHA256()`, `PasswordHash()`, `ComparePasswordHash()`, `NewEncryptionKey()`, `Encrypt()`, `Decrypt()`, `NewPersistedED25519()`, `ParseEdPrivateKey()`, `ParseEdPublicKey()`, `RandomBytes()`, `RandomBytesHex()`
|
||||
|
||||
### JWT Authentication (`jwt`)
|
||||
|
||||
JWT token signing and parsing with support for EdDSA and HS256 algorithms.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/jwt"
|
||||
|
||||
// EdDSA (recommended)
|
||||
token, err := jwt.SignEdDSA(privateKey, "issuer", "subject", time.Hour, extraClaims)
|
||||
claims, err := jwt.ParseEdDSA(token, publicKey, "issuer")
|
||||
|
||||
// HS256
|
||||
token, err := jwt.SignHS256(secret, "issuer", "subject", time.Hour, extraClaims)
|
||||
claims, err := jwt.ParseHS256(token, secret, "issuer")
|
||||
```
|
||||
|
||||
**Key Functions**: `Sign()`, `Parse()`, `SignEdDSA()`, `ParseEdDSA()`, `SignHS256()`, `ParseHS256()`
|
||||
|
||||
### Email Handling (`email`)
|
||||
|
||||
Email construction and delivery with SMTP support and development mode.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/email"
|
||||
|
||||
msg := &email.Message{
|
||||
From: "sender@example.com",
|
||||
To: []string{"recipient@example.com"},
|
||||
Subject: "Hello",
|
||||
Body: "<h1>Hello World</h1>",
|
||||
}
|
||||
|
||||
// SMTP transport
|
||||
transport := email.NewSMTPTransport("smtp.example.com", 587, "user", "pass")
|
||||
err := msg.Send(transport)
|
||||
|
||||
// Development mode (opens in browser)
|
||||
transport := email.NewDumpToTempTransport()
|
||||
err := msg.Send(transport)
|
||||
```
|
||||
|
||||
**Key Types**: `Message`, `Transport`, `SMTPTransport`, `DumpToTempTransport`
|
||||
|
||||
### Data Validation (`validate`)
|
||||
|
||||
Struct and map validation using go-playground/validator.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/validate"
|
||||
|
||||
type User struct {
|
||||
Email string `json:"email" validate:"required,email"`
|
||||
Age int `json:"age" validate:"gte=0,lte=130"`
|
||||
}
|
||||
|
||||
user := &User{Email: "test@example.com", Age: 25}
|
||||
err := validate.Struct(user) // Returns validation errors with JSON field names
|
||||
```
|
||||
|
||||
**Key Functions**: `Struct()`, `Map()`, `RegisterAlias()`, `RegisterValidation()`
|
||||
|
||||
### Environment Configuration (`dotenv`)
|
||||
|
||||
Environment file parsing with variable expansion and struct assignment.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/dotenv"
|
||||
|
||||
// Read .env file
|
||||
env, err := dotenv.Read(".env")
|
||||
|
||||
// Assign to struct
|
||||
type Config struct {
|
||||
Port int `env:"PORT"`
|
||||
Host string `env:"HOST,HOSTNAME"` // Supports fallback tags
|
||||
}
|
||||
cfg := &Config{}
|
||||
err := dotenv.Assign(env, cfg)
|
||||
|
||||
// Write .env file
|
||||
err := dotenv.Write(env, ".env")
|
||||
```
|
||||
|
||||
**Key Functions**: `Read()`, `LoadFile()`, `Write()`, `Assign()`
|
||||
|
||||
### HTTP Request Utilities (`request`)
|
||||
|
||||
Request parsing, validation, and pagination helpers.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/request"
|
||||
|
||||
// Parse and validate JSON payload
|
||||
type CreateUserRequest struct {
|
||||
Email string `json:"email" validate:"required,email"`
|
||||
}
|
||||
var req CreateUserRequest
|
||||
err := request.PayloadWithValidate(r, &req)
|
||||
|
||||
// Get pagination parameters
|
||||
pager := request.GetPager(r.URL.Query(), 50) // default page size 50
|
||||
```
|
||||
|
||||
**Key Functions**: `Payload()`, `PayloadWithValidate()`, `PayloadMap()`, `FormField()`, `GetPager()`
|
||||
|
||||
### HTTP Response Utilities (`response`)
|
||||
|
||||
Standardized JSON response formatting.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/response"
|
||||
|
||||
// Success responses
|
||||
response.Ok(w, data)
|
||||
response.Paged(w, data, pager, totalRecords)
|
||||
|
||||
// Error responses
|
||||
response.BadRequest(w, "Invalid input")
|
||||
response.InternalServerError(w, err)
|
||||
response.NotAuthorized(w, "Invalid credentials")
|
||||
response.Forbidden(w, "Access denied")
|
||||
response.SessionExpired(w)
|
||||
```
|
||||
|
||||
**Key Functions**: `Ok()`, `Paged()`, `BadRequest()`, `InternalServerError()`, `SessionExpired()`, `NotAuthorized()`, `Forbidden()`
|
||||
|
||||
### Pointer Utilities (`ptr`)
|
||||
|
||||
Safe reference and dereference operations with generic support.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/ptr"
|
||||
|
||||
// Generic reference/dereference
|
||||
strPtr := ptr.Ref("hello")
|
||||
str := ptr.Deref(strPtr, "default")
|
||||
|
||||
// Type-specific helpers
|
||||
boolPtr := ptr.Bool(true)
|
||||
numPtr := ptr.Number(42)
|
||||
strPtr := ptr.Str("test")
|
||||
|
||||
// Safe getters with defaults
|
||||
value := ptr.GetBool(boolPtr, false)
|
||||
num := ptr.GetNumber(numPtr, 0)
|
||||
str := ptr.GetStr(strPtr, "")
|
||||
```
|
||||
|
||||
**Key Functions**: `Ref()`, `Deref()`, `Bool()`, `GetBool()`, `Str()`, `GetStr()`, `StrTrim()`, `Number()`, `GetNumber()`
|
||||
|
||||
### Unique ID Generation (`uid`)
|
||||
|
||||
UUID v7 and Sqids-based ID generation.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/uid"
|
||||
|
||||
// UUID v7 (time-based)
|
||||
id := uid.NewUUID()
|
||||
|
||||
// Sqids (URL-friendly encoding)
|
||||
encoded := uid.Encode(123, 456)
|
||||
numbers, err := uid.Decode(encoded)
|
||||
```
|
||||
|
||||
**Key Functions**: `NewUUID()`, `Encode()`, `Decode()`
|
||||
|
||||
### Date/Time Utilities (`date`)
|
||||
|
||||
Date parsing, arithmetic, and boundary calculations.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/date"
|
||||
|
||||
// Parse ISO date
|
||||
t, err := date.ParseISODate("2024-01-15")
|
||||
|
||||
// Calculate working days
|
||||
days := date.CountWorkingDays(startDate, endDate)
|
||||
|
||||
// Date boundaries
|
||||
startOfDay := date.StartOfDay(now)
|
||||
endOfMonth := date.EndOfMonth(now)
|
||||
startOfWeek := date.StartOfWeek(now)
|
||||
|
||||
// Date arithmetic
|
||||
lastWeek := date.LastWeek()
|
||||
lastMonth := date.LastMonth()
|
||||
threeMonthsAgo := date.SubtractMonths(now, 3)
|
||||
```
|
||||
|
||||
**Key Functions**: `ParseISODate()`, `CountWorkingDays()`, `StartOfDay()`, `EndOfDay()`, `StartOfMonth()`, `EndOfMonth()`, `StartOfWeek()`, `EndOfWeek()`, `StartOfYear()`, `EndOfYear()`, `LastWeek()`, `LastMonth()`, `SubtractMonths()`, `SubtractDays()`, `SubtractAYear()`
|
||||
|
||||
### Compression (`gz`)
|
||||
|
||||
Gzip compression and decompression.
|
||||
|
||||
```go
|
||||
import "code.patial.tech/go/appcore/gz"
|
||||
|
||||
// Compress data
|
||||
compressed, err := gz.Zip([]byte("data"))
|
||||
|
||||
// Decompress data
|
||||
decompressed, err := gz.UnZip(compressed)
|
||||
```
|
||||
|
||||
**Key Functions**: `Zip()`, `UnZip()`
|
||||
|
||||
### Additional Utilities
|
||||
|
||||
- **`open`**: Cross-platform file/URI opening (`WithDefaultApp()`, `App()`)
|
||||
- **`structs`**: Reflection utilities (`Map()` - converts structs to maps)
|
||||
- **`mime`**: MIME type lookups from file extensions
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `github.com/go-playground/validator/v10` - Data validation
|
||||
- `github.com/golang-jwt/jwt/v5` - JWT handling
|
||||
- `github.com/google/uuid` - UUID generation
|
||||
- `github.com/sqids/sqids-go` - URL-friendly ID encoding
|
||||
- `golang.org/x/crypto` - Cryptographic primitives
|
||||
|
||||
## Use Cases
|
||||
|
||||
AppCore is particularly well-suited for:
|
||||
|
||||
- Building secure web applications and REST APIs
|
||||
- Standardizing authentication/authorization patterns
|
||||
- Email delivery systems
|
||||
- Configuration management
|
||||
- API response formatting
|
||||
- Data validation and sanitization
|
||||
|
||||
## Security
|
||||
|
||||
- **Password Hashing**: Uses Argon2id with OWASP-recommended parameters (m=19456, t=2, p=1)
|
||||
- **Encryption**: AES-GCM authenticated encryption
|
||||
- **JWT**: Supports EdDSA (recommended) and HS256 algorithms
|
||||
- **Random Generation**: Cryptographically secure random bytes
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) file for details.
|
||||
|
||||
Copyright 2024/2025 Patial Tech (Ankit Patial).
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please ensure:
|
||||
- Code follows Go best practices and project conventions
|
||||
- All tests pass (`go test ./...`)
|
||||
- New features include appropriate documentation
|
||||
- Security-sensitive code is reviewed carefully
|
||||
|
||||
## Support
|
||||
|
||||
For issues, questions, or feature requests, please open an issue on the project repository.
|
||||
|
||||
@@ -15,10 +15,14 @@ import (
|
||||
"io"
|
||||
)
|
||||
|
||||
// NewEncryptionKey will generate new key as base64 encoded string
|
||||
//
|
||||
// should be of 16, 24 or 32 bytes in length
|
||||
// NewEncryptionKey will generate new key as base64 encoded string.
|
||||
// Size must be 16, 24, or 32 bytes for AES-128, AES-192, or AES-256 respectively.
|
||||
func NewEncryptionKey(size uint8) (string, error) {
|
||||
// Validate AES key sizes
|
||||
if size != 16 && size != 24 && size != 32 {
|
||||
return "", fmt.Errorf("invalid key size %d: must be 16, 24, or 32 bytes for AES", size)
|
||||
}
|
||||
|
||||
b, err := RandomBytes(size)
|
||||
if err != nil {
|
||||
return "", err
|
||||
@@ -70,8 +74,14 @@ func Decrypt(key, text string) (string, error) {
|
||||
nonceSize := gcm.NonceSize()
|
||||
enc, err := hex.DecodeString(text)
|
||||
if err != nil {
|
||||
return "", err
|
||||
return "", fmt.Errorf("invalid hex encoding: %w", err)
|
||||
}
|
||||
|
||||
// Validate ciphertext length to prevent panic
|
||||
if len(enc) < nonceSize {
|
||||
return "", fmt.Errorf("ciphertext too short: got %d bytes, need at least %d", len(enc), nonceSize)
|
||||
}
|
||||
|
||||
nonce, ciphertext := enc[:nonceSize], enc[nonceSize:]
|
||||
|
||||
// decrypt
|
||||
|
||||
@@ -11,6 +11,21 @@ import (
|
||||
txt "text/template"
|
||||
)
|
||||
|
||||
// RenderHTMLTemplate renders HTML email templates with automatic XSS protection.
|
||||
//
|
||||
// SECURITY WARNING:
|
||||
// - DO NOT pass untrusted user input as layout or content parameters
|
||||
// - Only use trusted, predefined template strings
|
||||
// - User data should ONLY be passed via the data map parameter
|
||||
// - The html/template package auto-escapes data to prevent XSS
|
||||
// - Template injection attacks are possible if template strings come from user input
|
||||
//
|
||||
// Example of SECURE usage:
|
||||
//
|
||||
// const layoutTemplate = "<html><body>{{template \"content\" .}}</body></html>"
|
||||
// const contentTemplate = "<h1>Hello {{.Name}}</h1>"
|
||||
// data := map[string]any{"Name": userInput} // Safe - will be escaped
|
||||
// html, err := RenderHTMLTemplate(layoutTemplate, contentTemplate, data)
|
||||
func RenderHTMLTemplate(layout, content string, data map[string]any) (string, error) {
|
||||
// layout
|
||||
tpl, err := template.New("layout").Parse(layout)
|
||||
@@ -34,6 +49,21 @@ func RenderHTMLTemplate(layout, content string, data map[string]any) (string, er
|
||||
return buf.String(), nil
|
||||
}
|
||||
|
||||
// RenderTxtTemplate renders plain text email templates WITHOUT escaping.
|
||||
//
|
||||
// SECURITY WARNING:
|
||||
// - DO NOT use this function for HTML content (use RenderHTMLTemplate instead)
|
||||
// - DO NOT pass untrusted user input as the content parameter
|
||||
// - Only use trusted, predefined template strings
|
||||
// - User data should ONLY be passed via the data map parameter
|
||||
// - text/template does NOT provide XSS protection - no auto-escaping
|
||||
// - Template injection attacks are possible if content comes from user input
|
||||
//
|
||||
// Example of SECURE usage:
|
||||
//
|
||||
// const textTemplate = "Hello {{.Name}}, your order #{{.OrderID}} is confirmed."
|
||||
// data := map[string]any{"Name": userName, "OrderID": orderID}
|
||||
// text, err := RenderTxtTemplate(textTemplate, data)
|
||||
func RenderTxtTemplate(content string, data map[string]any) (string, error) {
|
||||
tpl, err := txt.New("content").Parse(content)
|
||||
if err != nil {
|
||||
|
||||
10
go.mod
10
go.mod
@@ -3,18 +3,18 @@ module code.patial.tech/go/appcore
|
||||
go 1.25
|
||||
|
||||
require (
|
||||
github.com/go-playground/validator/v10 v10.27.0
|
||||
github.com/go-playground/validator/v10 v10.28.0
|
||||
github.com/golang-jwt/jwt/v5 v5.3.0
|
||||
github.com/google/uuid v1.6.0
|
||||
github.com/sqids/sqids-go v0.4.1
|
||||
golang.org/x/crypto v0.42.0
|
||||
golang.org/x/crypto v0.45.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/gabriel-vasile/mimetype v1.4.10 // indirect
|
||||
github.com/gabriel-vasile/mimetype v1.4.11 // indirect
|
||||
github.com/go-playground/locales v0.14.1 // indirect
|
||||
github.com/go-playground/universal-translator v0.18.1 // indirect
|
||||
github.com/leodido/go-urn v1.4.0 // indirect
|
||||
golang.org/x/sys v0.36.0 // indirect
|
||||
golang.org/x/text v0.29.0 // indirect
|
||||
golang.org/x/sys v0.38.0 // indirect
|
||||
golang.org/x/text v0.31.0 // indirect
|
||||
)
|
||||
|
||||
10
go.sum
10
go.sum
@@ -2,6 +2,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/gabriel-vasile/mimetype v1.4.10 h1:zyueNbySn/z8mJZHLt6IPw0KoZsiQNszIpU+bX4+ZK0=
|
||||
github.com/gabriel-vasile/mimetype v1.4.10/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s=
|
||||
github.com/gabriel-vasile/mimetype v1.4.11 h1:AQvxbp830wPhHTqc1u7nzoLT+ZFxGY7emj5DR5DYFik=
|
||||
github.com/gabriel-vasile/mimetype v1.4.11/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s=
|
||||
github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
|
||||
github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
|
||||
github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
|
||||
@@ -10,6 +12,8 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn
|
||||
github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
|
||||
github.com/go-playground/validator/v10 v10.27.0 h1:w8+XrWVMhGkxOaaowyKH35gFydVHOvC0/uWoy2Fzwn4=
|
||||
github.com/go-playground/validator/v10 v10.27.0/go.mod h1:I5QpIEbmr8On7W0TktmJAumgzX4CA1XNl4ZmDuVHKKo=
|
||||
github.com/go-playground/validator/v10 v10.28.0 h1:Q7ibns33JjyW48gHkuFT91qX48KG0ktULL6FgHdG688=
|
||||
github.com/go-playground/validator/v10 v10.28.0/go.mod h1:GoI6I1SjPBh9p7ykNE/yj3fFYbyDOpwMn5KXd+m2hUU=
|
||||
github.com/golang-jwt/jwt/v5 v5.3.0 h1:pv4AsKCKKZuqlgs5sUmn4x8UlGa0kEVt/puTpKx9vvo=
|
||||
github.com/golang-jwt/jwt/v5 v5.3.0/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE=
|
||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||
@@ -24,9 +28,15 @@ github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcU
|
||||
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
|
||||
golang.org/x/crypto v0.42.0 h1:chiH31gIWm57EkTXpwnqf8qeuMUi0yekh6mT2AvFlqI=
|
||||
golang.org/x/crypto v0.42.0/go.mod h1:4+rDnOTJhQCx2q7/j6rAN5XDw8kPjeaXEUR2eL94ix8=
|
||||
golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q=
|
||||
golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4=
|
||||
golang.org/x/sys v0.36.0 h1:KVRy2GtZBrk1cBYA7MKu5bEZFxQk4NIDV6RLVcC8o0k=
|
||||
golang.org/x/sys v0.36.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
|
||||
golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk=
|
||||
golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4=
|
||||
golang.org/x/text v0.31.0 h1:aC8ghyu4JhP8VojJ2lEHBnochRno1sgL6nEi9WGFGMM=
|
||||
golang.org/x/text v0.31.0/go.mod h1:tKRAlv61yKIjGGHX/4tP1LTbc13YSec1pxVEWXzfoeM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
||||
1
gz/gz.go
1
gz/gz.go
@@ -34,6 +34,7 @@ func UnZip(data []byte) ([]byte, error) {
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer r.Close() // Ensure reader is closed to prevent resource leak
|
||||
|
||||
var resB bytes.Buffer
|
||||
if _, err := resB.ReadFrom(r); err != nil {
|
||||
|
||||
11
jwt/jwt.go
11
jwt/jwt.go
@@ -9,7 +9,6 @@ import (
|
||||
"crypto/ed25519"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log"
|
||||
"maps"
|
||||
"time"
|
||||
|
||||
@@ -51,14 +50,13 @@ func ParseEdDSA(key ed25519.PrivateKey, tokenString string, issuer string) (jwt.
|
||||
jwt.WithExpirationRequired(),
|
||||
)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
return nil, fmt.Errorf("failed to parse JWT token: %w", err)
|
||||
}
|
||||
|
||||
if claims, ok := token.Claims.(jwt.MapClaims); ok {
|
||||
return claims, nil
|
||||
} else {
|
||||
return nil, errors.New("no claims found")
|
||||
}
|
||||
return nil, errors.New("no claims found in token")
|
||||
}
|
||||
|
||||
func SignHS256(secret []byte, claims map[string]any, issuer string, d time.Duration) (string, error) {
|
||||
@@ -88,12 +86,11 @@ func ParseHS256(secret []byte, tokenString string, issuer string) (jwt.MapClaims
|
||||
jwt.WithExpirationRequired(),
|
||||
)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
return nil, fmt.Errorf("failed to parse JWT token: %w", err)
|
||||
}
|
||||
|
||||
if claims, ok := token.Claims.(jwt.MapClaims); ok {
|
||||
return claims, nil
|
||||
} else {
|
||||
return nil, errors.New("no claims found")
|
||||
}
|
||||
return nil, errors.New("no claims found in token")
|
||||
}
|
||||
|
||||
13
open/open.go
13
open/open.go
@@ -6,12 +6,23 @@
|
||||
package open
|
||||
|
||||
// WithDefaultApp open a file, directory, or URI using the OS's default application for that object type.
|
||||
// The input is validated to prevent path traversal and command injection attacks.
|
||||
func WithDefaultApp(input string) error {
|
||||
if err := validateInput(input); err != nil {
|
||||
return err
|
||||
}
|
||||
cmd := open(input)
|
||||
return cmd.Run()
|
||||
}
|
||||
|
||||
// WithApp will open a file directory, or URI using the specified application.
|
||||
// App will open a file directory, or URI using the specified application.
|
||||
// Both input and appName are validated to prevent command injection attacks.
|
||||
func App(input string, appName string) error {
|
||||
if err := validateInput(input); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := validateAppName(appName); err != nil {
|
||||
return err
|
||||
}
|
||||
return openWith(input, appName).Run()
|
||||
}
|
||||
|
||||
56
open/validate.go
Normal file
56
open/validate.go
Normal file
@@ -0,0 +1,56 @@
|
||||
// Copyright 2025 Patial Tech (Ankit Patial).
|
||||
//
|
||||
// This file is part of code.patial.tech/go/appcore, which is MIT licensed.
|
||||
// See http://opensource.org/licenses/MIT
|
||||
|
||||
package open
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// validateInput checks for common security issues in file paths
|
||||
func validateInput(input string) error {
|
||||
if input == "" {
|
||||
return errors.New("input path cannot be empty")
|
||||
}
|
||||
|
||||
// Clean the path to resolve . and .. references
|
||||
clean := filepath.Clean(input)
|
||||
|
||||
// Check for suspicious characters that could be used for injection
|
||||
// Allow URIs (http://, https://, etc.) but validate file paths
|
||||
if !strings.Contains(clean, "://") {
|
||||
// For file paths, check for path traversal attempts
|
||||
if strings.Contains(clean, "..") {
|
||||
return errors.New("path traversal detected in input")
|
||||
}
|
||||
|
||||
// Check if path exists (for file paths)
|
||||
if _, err := os.Stat(clean); err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return fmt.Errorf("path does not exist: %s", clean)
|
||||
}
|
||||
return fmt.Errorf("cannot access path: %w", err)
|
||||
}
|
||||
} else {
|
||||
// For URIs, validate scheme
|
||||
allowedSchemes := []string{"http://", "https://", "file://", "ftp://", "mailto:"}
|
||||
valid := false
|
||||
for _, scheme := range allowedSchemes {
|
||||
if strings.HasPrefix(strings.ToLower(clean), scheme) {
|
||||
valid = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !valid {
|
||||
return fmt.Errorf("URI scheme not allowed: %s", clean)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
28
open/validate_darwin.go
Normal file
28
open/validate_darwin.go
Normal file
@@ -0,0 +1,28 @@
|
||||
// Copyright 2025 Patial Tech (Ankit Patial).
|
||||
//
|
||||
// This file is part of code.patial.tech/go/appcore, which is MIT licensed.
|
||||
// See http://opensource.org/licenses/MIT
|
||||
|
||||
package open
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// validateAppName validates application names on macOS
|
||||
func validateAppName(appName string) error {
|
||||
if appName == "" {
|
||||
return errors.New("application name cannot be empty")
|
||||
}
|
||||
|
||||
// Check for suspicious characters that could be used for command injection
|
||||
dangerous := []string{";", "|", "&", "$", "`", "\n", "\r", "$(", "&&", "||"}
|
||||
for _, char := range dangerous {
|
||||
if strings.Contains(appName, char) {
|
||||
return errors.New("application name contains invalid characters")
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
34
open/validate_linux.go
Normal file
34
open/validate_linux.go
Normal file
@@ -0,0 +1,34 @@
|
||||
// Copyright 2025 Patial Tech (Ankit Patial).
|
||||
//
|
||||
// This file is part of code.patial.tech/go/appcore, which is MIT licensed.
|
||||
// See http://opensource.org/licenses/MIT
|
||||
|
||||
package open
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"os/exec"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// validateAppName validates application names on Linux with strict security checks
|
||||
func validateAppName(appName string) error {
|
||||
if appName == "" {
|
||||
return errors.New("application name cannot be empty")
|
||||
}
|
||||
|
||||
// Check for dangerous characters that could be used for command injection
|
||||
dangerous := []string{";", "|", "&", "$", "`", "\n", "\r", "$(", "&&", "||", ">", "<", "*"}
|
||||
for _, char := range dangerous {
|
||||
if strings.Contains(appName, char) {
|
||||
return errors.New("application name contains invalid characters")
|
||||
}
|
||||
}
|
||||
|
||||
// Verify the application exists in PATH (additional security check)
|
||||
if _, err := exec.LookPath(appName); err != nil {
|
||||
return errors.New("application not found in system PATH")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
28
open/validate_windows.go
Normal file
28
open/validate_windows.go
Normal file
@@ -0,0 +1,28 @@
|
||||
// Copyright 2025 Patial Tech (Ankit Patial).
|
||||
//
|
||||
// This file is part of code.patial.tech/go/appcore, which is MIT licensed.
|
||||
// See http://opensource.org/licenses/MIT
|
||||
|
||||
package open
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// validateAppName validates application names on Windows
|
||||
func validateAppName(appName string) error {
|
||||
if appName == "" {
|
||||
return errors.New("application name cannot be empty")
|
||||
}
|
||||
|
||||
// Check for dangerous characters in Windows cmd context
|
||||
dangerous := []string{";", "|", "&", "$", "`", "\n", "\r", "&&", "||", ">", "<", "^"}
|
||||
for _, char := range dangerous {
|
||||
if strings.Contains(appName, char) {
|
||||
return errors.New("application name contains invalid characters")
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -7,12 +7,19 @@ package request
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
|
||||
"code.patial.tech/go/appcore/validate"
|
||||
)
|
||||
|
||||
// MaxRequestBodySize is the maximum allowed size for request bodies (1MB default).
|
||||
// This prevents resource exhaustion attacks from large payloads.
|
||||
// Override this value if you need to accept larger requests.
|
||||
var MaxRequestBodySize int64 = 1 << 20 // 1MB
|
||||
|
||||
func FormField(r *http.Request, key string) (string, error) {
|
||||
f, err := Payload[map[string]any](r)
|
||||
if err != nil {
|
||||
@@ -41,8 +48,45 @@ func PayloadWithValidate[T any](r *http.Request) (T, error) {
|
||||
|
||||
func Payload[T any](r *http.Request) (T, error) {
|
||||
var p T
|
||||
if err := json.NewDecoder(r.Body).Decode(&p); err != nil {
|
||||
|
||||
// Limit request body size to prevent resource exhaustion
|
||||
limited := io.LimitReader(r.Body, MaxRequestBodySize)
|
||||
|
||||
decoder := json.NewDecoder(limited)
|
||||
if err := decoder.Decode(&p); err != nil {
|
||||
// Check if we hit the size limit
|
||||
if err == io.EOF || err == io.ErrUnexpectedEOF {
|
||||
// Try to read one more byte to see if there's more data
|
||||
var buf [1]byte
|
||||
if n, _ := limited.Read(buf[:]); n == 0 {
|
||||
// We hit the limit
|
||||
return p, errors.New("request body too large")
|
||||
}
|
||||
}
|
||||
return p, err
|
||||
}
|
||||
return p, nil
|
||||
}
|
||||
|
||||
// DecodeJSON decodes JSON from the request body into the provided pointer.
|
||||
// This is useful when you want to decode into an existing variable.
|
||||
// The request body size is limited by MaxRequestBodySize to prevent DoS attacks.
|
||||
func DecodeJSON(r *http.Request, v any) error {
|
||||
// Limit request body size to prevent resource exhaustion
|
||||
limited := io.LimitReader(r.Body, MaxRequestBodySize)
|
||||
|
||||
decoder := json.NewDecoder(limited)
|
||||
if err := decoder.Decode(v); err != nil {
|
||||
// Check if we hit the size limit
|
||||
if err == io.EOF || err == io.ErrUnexpectedEOF {
|
||||
// Try to read one more byte to see if there's more data
|
||||
var buf [1]byte
|
||||
if n, _ := limited.Read(buf[:]); n == 0 {
|
||||
// We hit the limit
|
||||
return errors.New("request body too large")
|
||||
}
|
||||
}
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user