Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lrstanley/chix

helper middleware and functionality for go-chi/chi
https://github.com/lrstanley/chix

authentication go go-chi golang helper http middleware

Last synced: 7 days ago
JSON representation

helper middleware and functionality for go-chi/chi

Awesome Lists containing this project

README 

        

![logo](https://liam.sh/-/gh/svg/lrstanley/chix?icon=logos%3Ago&icon.height=65&layout=left&font=1.1&icon.color=rgba%280%2C+0%2C+0%2C+1%29)





  

    

  

  

    

  



  

    

  



  

    

  



  

    

  

  

    

  





  

    

  

  

    

  

  

    

  

  

    

  

  




## :link: Table of Contents



  - [Usage](#gear-usage)

  - [Features](#sparkles-features)

  - [Related Libraries](#zap-related-libraries)

  - [Example Projects](#bulb-example-projects)

  - [Support & Assistance](#raising_hand_man-support--assistance)

  - [Contributing](#handshake-contributing)

  - [License](#balance_scale-license)



## :gear: Usage



```console

go get -u github.com/lrstanley/chix@latest

```



## :sparkles: Features



- `http.Server` wrapper that easily allows starting, and gracefully shutting

  down your http server, and other background services, using `errgroup`.

- RealIP middleware (supports whitelisting specific proxies, rather than allowing

  any source).

- private IP middleware, restricting endpoints to be internal only.

- Rendering helpers:

  - `JSON` (with `?pretty=true` support).

- Auth middleware:

  - Uses [markbates/goth](https://github.com/markbates/goth) to support many

    different providers.

  - Encrypts session cookies, which removes the need for local session storage.

  - Uses Go 1.18's generics functionality to provide a custom ID and auth object

    resolver.

    - No longer have to type assert to your local models!

  - Optionally requiring authentication.

  - Optionally requiring specific roles.

  - Optionally adding authentication info to context for use by children handlers.

  - API key validation.

  - API version validation.

- Struct/type binding, from get/post data, with support for [go-playground/validator](https://github.com/go-playground/validator).

- Structured logging using [apex/log](https://github.com/apex/log) (same API

  as logrus).

  - Allows injecting additional metadata into logs.

  - Injects logger into context for use by children handlers.

- Debug middleware:

  - Easily let children handlers know if global debug flags are enabled.

  - Allows masking errors, unless debugging is enabled.

- Error handler, that automatically handles api-vs-static content responses.

  - Supports `ErrorResolver`'s, providing the ability to override status codes

    for specific types of errors.

- `go:embed` helpers for mounting an embedded filesystem seamlessly as an http

  endpoint.

  - Useful for projects that bundle their frontend assets in their binary.

  - Supports local filesystem reading, when debugging is enabled (TODO).

- Middleware for robots.txt and security.txt responding.



## :zap: Related Libraries



- [lrstanley/clix](https://github.com/lrstanley/clix) -- go-flags wrapper, that

  handles parsing and decoding, with additional helpers.

- [lrstanley/go-query-parser](https://github.com/lrstanley/go-queryparser) -- similar

  to that of Google/Github/etc search, a query string parser that allows filters

  and tags to be dynamically configured by the end user.



## :bulb: Example Projects



Use these as a reference point for how you might use some of the functionality within

this library, or how you might want to structure your applications.



- [lrstanley/geoip](https://github.com/lrstanley/geoip)

- [lrstanley/liam.sh](https://github.com/lrstanley/liam.sh)

- [lrstanley/spectrograph](https://github.com/lrstanley/spectrograph)



## :raising_hand_man: Support & Assistance



* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for

     guidelines on ensuring everyone has the best experience interacting with

     the community.

* :raising_hand_man: Take a look at the [support](.github/SUPPORT.md) document on

     guidelines for tips on how to ask the right questions.

* :lady_beetle: For all features/bugs/issues/questions/etc, [head over here](https://github.com/lrstanley/chix/issues/new/choose).



## :handshake: Contributing



* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines

     on ensuring everyone has the best experience interacting with the

    community.

* :clipboard: Please review the [contributing](.github/CONTRIBUTING.md) doc for submitting

     issues/a guide on submitting pull requests and helping out.

* :old_key: For anything security related, please review this repositories [security policy](https://github.com/lrstanley/chix/security/policy).



## :balance_scale: License



```

MIT License



Copyright (c) 2022 Liam Stanley 



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

```



_Also located [here](LICENSE)_