Compare commits

..

4 Commits

7 changed files with 356 additions and 64 deletions

173
README.md
View File

@ -15,7 +15,7 @@ func main() {
// Initialize sessions
sushi.InitSessions("sessions.json")
app.Get("/", func(ctx sushi.Ctx, params []any) {
app.Get("/", func(ctx sushi.Ctx) {
ctx.SendHTML("<h1>Hello Sushi!</h1>")
})
@ -41,35 +41,86 @@ api.Get("/users", listUsersHandler)
api.Post("/users", createUserHandler)
```
## Parameters
## Parameters and Queries
URL parameters are automatically converted to the appropriate type:
Sushi provides a fluent API for accessing URL parameters, query strings, and form data with automatic type conversion:
### URL Parameters (Named Routes)
```go
// Numeric parameters become integers
app.Get("/users/:id", func(ctx sushi.Ctx, params []any) {
userID := params[0].(int) // /users/123 -> 123
// ...
app.Get("/users/:id", func(ctx sushi.Ctx) {
// Get URL parameter with fluent API
userID := ctx.Param("id").Int() // /users/123 -> 123
userIDStr := ctx.Param("id").String() // /users/123 -> "123"
// With defaults
limit := ctx.Param("limit").IntDefault(10)
})
// String parameters stay strings
app.Get("/users/:name", func(ctx sushi.Ctx, params []any) {
name := params[0].(string) // /users/john -> "john"
// ...
})
app.Get("/users/:id/posts/:slug", func(ctx sushi.Ctx) {
userID := ctx.Param("id").Int()
slug := ctx.Param("slug").String()
// Mixed types
app.Get("/users/:id/posts/:slug", func(ctx sushi.Ctx, params []any) {
userID := params[0].(int) // 123
slug := params[1].(string) // "my-post"
// ...
// Check if parameter exists
if ctx.Param("optional").Exists() {
// Handle optional parameter
}
})
```
### Query Parameters
```go
app.Get("/search", func(ctx sushi.Ctx) {
// Get query parameters with fluent API
query := ctx.Query("q").String() // ?q=hello -> "hello"
page := ctx.Query("page").IntDefault(1) // ?page=2 -> 2
limit := ctx.Query("limit").IntDefault(20) // Default to 20 if not present
sortBy := ctx.Query("sort").StringDefault("name") // Default to "name"
// Boolean query params
includeDeleted := ctx.Query("deleted").Bool() // ?deleted=true -> true
// Float values
minPrice := ctx.Query("min_price").Float() // ?min_price=19.99 -> 19.99
// Check existence
if ctx.Query("filter").Exists() {
filter := ctx.Query("filter").String()
// Apply filter
}
})
```
## Form Data
Access form data with the fluent API:
```go
app.Post("/users", func(ctx sushi.Ctx) {
// Get form fields with fluent API
name := ctx.Input("name").String()
email := ctx.Input("email").String()
age := ctx.Input("age").IntDefault(0)
// Check if checkbox is checked
agreeToTerms := ctx.Input("terms").Bool() // Checks for "true", "on", "1", "yes"
// Validate required fields
if ctx.Input("email").IsEmpty() {
ctx.SendError(400, "Email is required")
return
}
// Get array of values (for multiple select, checkboxes)
tags := ctx.GetFormArray("tags[]")
})
```
## Response Helpers
```go
func myHandler(ctx sushi.Ctx, params []any) {
func myHandler(ctx sushi.Ctx) {
// JSON responses
ctx.SendJSON(map[string]string{"message": "success"})
@ -87,15 +138,20 @@ func myHandler(ctx sushi.Ctx, params []any) {
// Status only
ctx.SendStatus(204)
// File responses
ctx.SendFile("/path/to/file.pdf")
// Raw bytes
ctx.SendBytes(imageData, "image/png")
}
```
## Middleware
```go
// Custom middleware
func loggingMiddleware() sushi.Middleware {
return func(ctx sushi.Ctx, params []any, next func()) {
return func(ctx sushi.Ctx, next func()) {
println("Request:", string(ctx.Method()), string(ctx.Path()))
next()
println("Status:", ctx.Response.StatusCode())
@ -111,16 +167,51 @@ admin.Use(auth.RequireAuth("/login"))
## Authentication Workflow
### 1. Setup Password Hashing
### 1. Password Hashing
The password package supports both Argon2 (default) and Bcrypt algorithms with configurable settings:
```go
import "git.sharkk.net/Sharkk/Sushi/password"
// Hash password for storage
// Using default Argon2 configuration
hashedPassword := password.HashPassword("userpassword123")
// Verify password during login
// Verify password (auto-detects algorithm)
isValid, err := password.VerifyPassword("userpassword123", hashedPassword)
// Configure for Bcrypt
password.SetConfig(password.Config{
Algorithm: password.Bcrypt,
Bcrypt: password.BcryptConfig{
Cost: 12, // Higher = more secure but slower
},
})
// Configure for Argon2 with custom settings
password.SetConfig(password.Config{
Algorithm: password.Argon2,
Argon2: password.Argon2Config{
Time: 3, // Iterations
Memory: 128 * 1024, // 128 MB
Threads: 4,
KeyLen: 32,
},
})
// Use preset configurations
password.SetConfig(password.Config{
Algorithm: password.Argon2,
Argon2: password.SecureArgon2Config(), // More secure, slower
// Or: password.FastArgon2Config() for development
})
// Check if password needs rehashing (algorithm or params changed)
if password.NeedsRehash(userHashedPassword) {
// Rehash password after successful verification
newHash := password.HashPassword(plainPassword)
// Update stored hash in database
}
```
### 2. User Structure
@ -176,9 +267,16 @@ func main() {
### 4. Login Handler
```go
func loginHandler(ctx sushi.Ctx, params []any) {
email := string(ctx.PostArgs().Peek("email"))
password := string(ctx.PostArgs().Peek("password"))
func loginHandler(ctx sushi.Ctx) {
// Use fluent API for form data
email := ctx.Input("email").String()
password := ctx.Input("password").String()
// Validate inputs
if ctx.Input("email").IsEmpty() || ctx.Input("password").IsEmpty() {
ctx.SendError(400, "Email and password are required")
return
}
// Find user by email/username
user := findUserByEmail(email)
@ -204,7 +302,7 @@ func loginHandler(ctx sushi.Ctx, params []any) {
### 5. Logout Handler
```go
func logoutHandler(ctx sushi.Ctx, params []any) {
func logoutHandler(ctx sushi.Ctx) {
ctx.Logout()
ctx.Redirect("/")
}
@ -213,7 +311,7 @@ func logoutHandler(ctx sushi.Ctx, params []any) {
### 6. Getting Current User
```go
func dashboardHandler(ctx sushi.Ctx, params []any) {
func dashboardHandler(ctx sushi.Ctx) {
user := ctx.GetCurrentUser().(*User)
html := fmt.Sprintf("<h1>Welcome, %s!</h1>", user.Username)
@ -230,7 +328,7 @@ import "git.sharkk.net/Sharkk/Sushi/csrf"
app.Use(csrf.Middleware())
// In your form template
func loginPageHandler(ctx sushi.Ctx, params []any) {
func loginPageHandler(ctx sushi.Ctx) {
csrfField := csrf.CSRFHiddenField(ctx)
html := fmt.Sprintf(`
@ -266,7 +364,7 @@ app.Get("/assets/*path", sushi.StaticEmbed(files))
## Sessions
```go
func someHandler(ctx sushi.Ctx, params []any) {
func someHandler(ctx sushi.Ctx) {
sess := ctx.GetCurrentSession()
// Set session data
@ -357,7 +455,7 @@ func main() {
app.Listen(":8080")
}
func homeHandler(ctx sushi.Ctx, params []any) {
func homeHandler(ctx sushi.Ctx) {
if ctx.IsAuthenticated() {
ctx.Redirect("/dashboard")
return
@ -365,7 +463,7 @@ func homeHandler(ctx sushi.Ctx, params []any) {
ctx.SendHTML(`<a href="/login">Login</a>`)
}
func loginPageHandler(ctx sushi.Ctx, params []any) {
func loginPageHandler(ctx sushi.Ctx) {
html := fmt.Sprintf(`
<form method="POST" action="/login">
%s
@ -378,9 +476,10 @@ func loginPageHandler(ctx sushi.Ctx, params []any) {
ctx.SendHTML(html)
}
func loginHandler(ctx sushi.Ctx, params []any) {
email := string(ctx.PostArgs().Peek("email"))
pass := string(ctx.PostArgs().Peek("password"))
func loginHandler(ctx sushi.Ctx) {
// Use fluent API for form data
email := ctx.Input("email").String()
pass := ctx.Input("password").String()
user := findUserByEmail(email)
if user == nil {
@ -397,7 +496,7 @@ func loginHandler(ctx sushi.Ctx, params []any) {
ctx.Redirect("/dashboard")
}
func dashboardHandler(ctx sushi.Ctx, params []any) {
func dashboardHandler(ctx sushi.Ctx) {
user := ctx.GetCurrentUser().(*User)
html := fmt.Sprintf(`
@ -411,7 +510,7 @@ func dashboardHandler(ctx sushi.Ctx, params []any) {
ctx.SendHTML(html)
}
func logoutHandler(ctx sushi.Ctx, params []any) {
func logoutHandler(ctx sushi.Ctx) {
ctx.Logout()
ctx.Redirect("/")
}

View File

@ -7,12 +7,22 @@ import (
const UserCtxKey = "user"
// Middleware adds authentication handling
func Middleware(userLookup func(int) any) sushi.Middleware {
// Auth holds the authentication middleware and user lookup function
type Auth struct {
userLookup func(int) any
}
// New creates a new Auth instance
func New(userLookup func(int) any) *Auth {
return &Auth{userLookup: userLookup}
}
// Middleware returns the authentication middleware function
func (a *Auth) Middleware() sushi.Middleware {
return func(ctx sushi.Ctx, next func()) {
sess := sushi.GetCurrentSession(ctx)
if sess != nil && sess.UserID > 0 && userLookup != nil {
user := userLookup(sess.UserID)
if sess != nil && sess.UserID > 0 && a.userLookup != nil {
user := a.userLookup(sess.UserID)
if user != nil {
ctx.SetUserValue(UserCtxKey, user)
} else {
@ -24,6 +34,15 @@ func Middleware(userLookup func(int) any) sushi.Middleware {
}
}
// Update refreshes the current user data in the context
func (a *Auth) Update(ctx sushi.Ctx) {
sess := sushi.GetCurrentSession(ctx)
if sess != nil && sess.UserID > 0 && a.userLookup != nil {
user := a.userLookup(sess.UserID)
ctx.SetUserValue(UserCtxKey, user)
}
}
// RequireAuth middleware that redirects unauthenticated users
func RequireAuth(redirectPath ...string) sushi.Middleware {
redirect := "/login"

View File

@ -10,13 +10,18 @@ type FormValue struct {
exists bool
}
// Form gets a form field for chaining
func (ctx Ctx) Form(key string) FormValue {
// Input gets a form field for chaining
func (ctx Ctx) Input(key string) FormValue {
value := string(ctx.PostArgs().Peek(key))
exists := ctx.PostArgs().Has(key)
return FormValue{value: value, exists: exists}
}
// Form gets a form field for chaining (deprecated: use Input instead)
func (ctx Ctx) Form(key string) FormValue {
return ctx.Input(key)
}
// String returns the value as string
func (f FormValue) String() string {
return f.value

View File

@ -5,23 +5,12 @@ import (
"strings"
)
const RouteParamsCtxKey = "route_params"
type ParamValue struct {
value string
exists bool
}
// RouteParam gets a route parameter by index for chaining
func (ctx Ctx) RouteParam(index int) ParamValue {
if params, ok := ctx.UserValue(RouteParamsCtxKey).([]string); ok {
if index >= 0 && index < len(params) {
return ParamValue{value: params[index], exists: true}
}
}
return ParamValue{value: "", exists: false}
}
// Param gets a route parameter by name for chaining (requires named params)
func (ctx Ctx) Param(name string) ParamValue {
if paramMap, ok := ctx.UserValue("param_names").(map[string]string); ok {
@ -32,6 +21,13 @@ func (ctx Ctx) Param(name string) ParamValue {
return ParamValue{value: "", exists: false}
}
// Query gets a query parameter for chaining
func (ctx Ctx) Query(key string) ParamValue {
value := string(ctx.QueryArgs().Peek(key))
exists := ctx.QueryArgs().Has(key)
return ParamValue{value: value, exists: exists}
}
// String returns the value as string
func (p ParamValue) String() string {
return p.value

View File

@ -8,33 +8,158 @@ import (
"strings"
"golang.org/x/crypto/argon2"
"golang.org/x/crypto/bcrypt"
)
// Algorithm represents the hashing algorithm to use
type Algorithm int
const (
argonTime = 1
argonMemory = 64 * 1024
argonThreads = 4
argonKeyLen = 32
Argon2 Algorithm = iota
Bcrypt
)
// HashPassword creates an argon2id hash of the password
// Argon2Config holds configuration for Argon2 hashing
type Argon2Config struct {
Time uint32 // Number of iterations
Memory uint32 // Memory usage in KB
Threads uint8 // Number of threads
KeyLen uint32 // Length of generated hash
}
// BcryptConfig holds configuration for Bcrypt hashing
type BcryptConfig struct {
Cost int // Bcrypt cost factor (4-31)
}
// Config holds the password hashing configuration
type Config struct {
Algorithm Algorithm
Argon2 Argon2Config
Bcrypt BcryptConfig
}
// DefaultArgon2Config returns recommended Argon2 settings
func DefaultArgon2Config() Argon2Config {
return Argon2Config{
Time: 1,
Memory: 64 * 1024, // 64 MB
Threads: 4,
KeyLen: 32,
}
}
// SecureArgon2Config returns more secure Argon2 settings (slower but more resistant)
func SecureArgon2Config() Argon2Config {
return Argon2Config{
Time: 3,
Memory: 128 * 1024, // 128 MB
Threads: 4,
KeyLen: 32,
}
}
// FastArgon2Config returns faster Argon2 settings (for testing/development)
func FastArgon2Config() Argon2Config {
return Argon2Config{
Time: 1,
Memory: 32 * 1024, // 32 MB
Threads: 2,
KeyLen: 32,
}
}
// DefaultBcryptConfig returns recommended Bcrypt settings
func DefaultBcryptConfig() BcryptConfig {
return BcryptConfig{
Cost: bcrypt.DefaultCost, // 10
}
}
// SecureBcryptConfig returns more secure Bcrypt settings (slower but more resistant)
func SecureBcryptConfig() BcryptConfig {
return BcryptConfig{
Cost: 12,
}
}
// DefaultConfig returns the default configuration (Argon2 with default settings)
func DefaultConfig() Config {
return Config{
Algorithm: Argon2,
Argon2: DefaultArgon2Config(),
Bcrypt: DefaultBcryptConfig(),
}
}
var globalConfig = DefaultConfig()
// SetConfig sets the global password configuration
func SetConfig(config Config) {
globalConfig = config
}
// GetConfig returns the current global password configuration
func GetConfig() Config {
return globalConfig
}
// HashPassword creates a hash of the password using the global configuration
func HashPassword(password string) string {
return HashPasswordWithConfig(password, globalConfig)
}
// HashPasswordWithConfig creates a hash of the password using the specified configuration
func HashPasswordWithConfig(password string, config Config) string {
switch config.Algorithm {
case Bcrypt:
return hashBcrypt(password, config.Bcrypt)
case Argon2:
fallthrough
default:
return hashArgon2(password, config.Argon2)
}
}
// hashArgon2 creates an argon2id hash of the password
func hashArgon2(password string, config Argon2Config) string {
salt := make([]byte, 16)
rand.Read(salt)
hash := argon2.IDKey([]byte(password), salt, argonTime, argonMemory, argonThreads, argonKeyLen)
hash := argon2.IDKey([]byte(password), salt, config.Time, config.Memory, config.Threads, config.KeyLen)
b64Salt := base64.RawStdEncoding.EncodeToString(salt)
b64Hash := base64.RawStdEncoding.EncodeToString(hash)
encoded := fmt.Sprintf("$argon2id$v=%d$m=%d,t=%d,p=%d$%s$%s",
argon2.Version, argonMemory, argonTime, argonThreads, b64Salt, b64Hash)
argon2.Version, config.Memory, config.Time, config.Threads, b64Salt, b64Hash)
return encoded
}
// hashBcrypt creates a bcrypt hash of the password
func hashBcrypt(password string, config BcryptConfig) string {
hash, err := bcrypt.GenerateFromPassword([]byte(password), config.Cost)
if err != nil {
// Fallback to default cost if provided cost is invalid
hash, _ = bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
}
return string(hash)
}
// VerifyPassword checks if a password matches the hash
func VerifyPassword(password, encodedHash string) (bool, error) {
// Detect hash type by prefix
if strings.HasPrefix(encodedHash, "$2a$") || strings.HasPrefix(encodedHash, "$2b$") || strings.HasPrefix(encodedHash, "$2y$") {
return verifyBcrypt(password, encodedHash)
} else if strings.HasPrefix(encodedHash, "$argon2id$") {
return verifyArgon2(password, encodedHash)
}
return false, fmt.Errorf("unsupported hash format")
}
// verifyArgon2 checks if a password matches an argon2 hash
func verifyArgon2(password, encodedHash string) (bool, error) {
parts := strings.Split(encodedHash, "$")
if len(parts) != 6 {
return false, fmt.Errorf("invalid hash format")
@ -77,3 +202,52 @@ func VerifyPassword(password, encodedHash string) (bool, error) {
return false, nil
}
// verifyBcrypt checks if a password matches a bcrypt hash
func verifyBcrypt(password, encodedHash string) (bool, error) {
err := bcrypt.CompareHashAndPassword([]byte(encodedHash), []byte(password))
if err == bcrypt.ErrMismatchedHashAndPassword {
return false, nil
}
if err != nil {
return false, err
}
return true, nil
}
// NeedsRehash checks if a hash needs to be updated to current configuration
func NeedsRehash(encodedHash string) bool {
// Check if using bcrypt when we want argon2
if globalConfig.Algorithm == Argon2 && (strings.HasPrefix(encodedHash, "$2a$") || strings.HasPrefix(encodedHash, "$2b$") || strings.HasPrefix(encodedHash, "$2y$")) {
return true
}
// Check if using argon2 when we want bcrypt
if globalConfig.Algorithm == Bcrypt && strings.HasPrefix(encodedHash, "$argon2id$") {
return true
}
// For bcrypt, check if cost has changed
if strings.HasPrefix(encodedHash, "$2") {
cost, err := bcrypt.Cost([]byte(encodedHash))
if err == nil && cost != globalConfig.Bcrypt.Cost {
return true
}
}
// For argon2, check if parameters have changed
if strings.HasPrefix(encodedHash, "$argon2id$") {
parts := strings.Split(encodedHash, "$")
if len(parts) == 6 {
var m, t, p uint32
_, err := fmt.Sscanf(parts[3], "m=%d,t=%d,p=%d", &m, &t, &p)
if err == nil {
if m != globalConfig.Argon2.Memory || t != globalConfig.Argon2.Time || p != uint32(globalConfig.Argon2.Threads) {
return true
}
}
}
}
return false
}

View File

@ -57,10 +57,8 @@ func (r *Router) ServeHTTP(ctx *fasthttp.RequestCtx) {
}
// Store params in context
sushiCtx := Ctx{ctx}
sushiCtx := Ctx{RequestCtx: ctx, Params: params}
if len(params) > 0 {
sushiCtx.SetUserValue(RouteParamsCtxKey, params)
// Create named param map if param names exist
if len(paramNames) > 0 {
paramMap := make(map[string]string)

View File

@ -8,6 +8,7 @@ import (
type Ctx struct {
*fasthttp.RequestCtx
Params []string
}
type Handler func(ctx Ctx)