README
¶
go-http
Introduction
This is a library implemented in Go (Golang) that provides some functionality to deal with HTTP requests and certain headers.
Usage
Install using go get codeberg.org/THREATINT/go-http.
Quality Values
Use ParseQualityValues() to parse client headers like Accept-Language.
(e.g. fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5)
Please see RFC #9110, 12.4.2 Quality Values for details.
ClientIP
ClientIP() returns the client ip address from HTTP headers. It works with X-Forwarded-For
(used by most reverse proxies) and is aware of True-Client-IP and CF-Connecting-IP
(both implemented by CloudFlare) and others.
ETagMiddleware
ETagMiddleware() adds strong ETag headers to HTTP responses as defined in
RFC #9110, 8.3.3 ETag.
MimeType
MimeTypeByExtension() provides a mapping for know file extension to mime type
(e.g. .html -> text/html) based on the builtin mime.TypeByExtension
and svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types.
Part of the source code for this functionality is generated by GenMimeType.py.
(also provided in this repository)
LoadTemplates()
LoadTemplates() recursively loads all templates (*.html) from a given directory.
FileServer
Serves static files, but don't allow directory listings (-> HTTP 404).
Feedback
We would love to hear from you! Please contact us at [email protected] for feedback and general requests. Kindly raise an issue in Codeberg if you find a problem in the code.
Want to know what we do when we're not developing open-source software? Find out at www.threatint.eu ;-)
License
Release under the MIT License. (see LICENSE)
Documentation
¶
Index ¶
- func ClientIP(req *http.Request) (string, error)
- func ETagMiddleware(config *ETagMiddlewareConfig) func(http.Handler) http.Handler
- func FilterAllowedParams(urlParameters url.Values, allowedParams []string) (url.Values, bool)
- func LoadTemplates(dir string) (*template.Template, error)
- func MimeTypeByExtension(extension string) string
- type ETagMiddlewareConfig
- type FileServer
- type QualityValue
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ETagMiddleware ¶
func ETagMiddleware(config *ETagMiddlewareConfig) func(http.Handler) http.Handler
ETagMiddleware middleware to add strong ETags , see https://www.rfc-editor.org/rfc/rfc9110#name-etag for details
func FilterAllowedParams ¶
func LoadTemplates ¶ added in v1.6.0
LoadTemplate recursively load all html templates (*.html) from a directory
func MimeTypeByExtension ¶
MimeTypeByExtension (extension) Return matching MimeType for file extension
Types ¶
type ETagMiddlewareConfig ¶
type FileServer ¶ added in v1.7.0
type FileServer struct {
FS http.FileSystem
}
FileServer serve static files, don't allow directory listings
type QualityValue ¶
QualityValue represents a values with quality factor, see https://www.rfc-editor.org/rfc/rfc9110.html#name-quality-values
func ParseQualityValues ¶
func ParseQualityValues(header string) ([]QualityValue, error)
ParseQualityValues parses a string containing values and quality factor, see https://www.rfc-editor.org/rfc/rfc9110.html#name-quality-values
Source Files