h/golib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation for JWT, HWS, and HWSAuth packages.

Browse Source 
- Updated JWT README.md with proper format and version number
- Updated HWS README.md and created comprehensive doc.go
- Updated HWSAuth README.md and doc.go with proper environment variable documentation
- All documentation now follows GOLIB rules format

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Haelnorr
2026-01-13 13:37:37 +11:00
parent 52341aba56
commit bdae21ec0b
5 changed files with 217 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
jwt/README.md
View File

@@ -1,20 +1,19 @@
# JWT Package
[![Go Reference](https://pkg.go.dev/badge/git.haelnorr.com/h/golib/jwt.svg)](https://pkg.go.dev/git.haelnorr.com/h/golib/jwt)
# JWT - v0.10.0-hlogdoc
JWT (JSON Web Token) generation and validation with database-backed token revocation support.
## Features
- 🔐 Access and refresh token generation
- ✅ Token validation with expiration checking
- 🚫 Token revocation via database blacklist
- 🗄️ Multi-database support (PostgreSQL, MySQL, SQLite, MariaDB)
- 🔧 Compatible with database/sql, GORM, and Bun
- 🤖 Automatic table creation and management
- 🧹 Database-native automatic cleanup
- 🔄 Token freshness tracking
- 💾 "Remember me" functionality
- Access and refresh token generation
- Token validation with expiration checking
- Token revocation via database blacklist
- Multi-database support (PostgreSQL, MySQL, SQLite, MariaDB)
- Compatible with database/sql, GORM, and Bun ORMs
- Automatic table creation and management
- Database-native automatic cleanup
- Token freshness tracking for sensitive operations
- "Remember me" functionality with session vs persistent tokens
- Manual cleanup method for on-demand token cleanup
## Installation
@@ -41,7 +40,7 @@ func main() {
// Create a transaction getter function
txGetter := func(ctx context.Context) (jwt.DBTransaction, error) {
return db.Begin()
return db.BeginTx(ctx, nil)
}
// Create token generator
@@ -78,16 +77,9 @@ func main() {
## Documentation
Comprehensive documentation is available in the [Wiki](https://git.haelnorr.com/h/golib/wiki/JWT).
For detailed documentation, see the [JWT Wiki](https://git.haelnorr.com/h/golib-wiki/JWT).
### Key Topics
- [Configuration](https://git.haelnorr.com/h/golib/wiki/JWT#configuration)
- [Token Generation](https://git.haelnorr.com/h/golib/wiki/JWT#token-generation)
- [Token Validation](https://git.haelnorr.com/h/golib/wiki/JWT#token-validation)
- [Token Revocation](https://git.haelnorr.com/h/golib/wiki/JWT#token-revocation)
- [Cleanup](https://git.haelnorr.com/h/golib/wiki/JWT#cleanup)
- [Using with ORMs](https://git.haelnorr.com/h/golib/wiki/JWT#using-with-orms)
Additional API documentation is available at [GoDoc](https://pkg.go.dev/git.haelnorr.com/h/golib/jwt).
## Supported Databases
@@ -98,8 +90,13 @@ Comprehensive documentation is available in the [Wiki](https://git.haelnorr.com/
## License
See LICENSE file in the repository root.
This project is licensed under the MIT License - see the LICENSE file for details.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
Contributions are welcome! Please feel free to submit a Pull Request.
## Related Projects
- [hwsauth](https://git.haelnorr.com/h/golib/hwsauth) - JWT-based authentication middleware for HWS
- [hws](https://git.haelnorr.com/h/golib/hws) - HTTP web server framework