README
¶
OpenSight GoLang libraries
About
The code maintained in this repository is used by the Greenbone OpenSight Backend Components written in GoLang.
The following functionalities are provided:
- configReader - reads the configuration based on environment variables with predefined defaults
- dbcrypt - provides encryption / decryption for fields of entities persisted with GORM
- errorResponses - rest api models for errors
- jobQueue - a simple job queue
- notifications - a client to send notifications to the openSight Notification Service
- openSearch - a client and extension functions to query openSearch - suited for the query package
- postgres - provides utilities for building conditional queries for PostgreSQL databases
- query - provides basic selector and response objects for requests, including filter, paging and sorting
- retryableRequest - provides function to execute a http request with retries on failures
- secretfiles - helps with accessing secrets stored in files
- slices - utility functions for slices
- testFolder - access to test data from the file system
- logs - context-aware structured logging utilities based on zerolog.
Maintainer
This project is maintained by Greenbone AG
Contributing
Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.
License
Copyright (C) 2022-2023 Greenbone AG
Licensed under the GNU General Public License v3.0 or later.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
errorResponses
Package errorResponses provides rest api models for errors
|
Package errorResponses provides rest api models for errors |
|
jobQueue
Package jobQueue provides a thread-safe queue of requests to execute a predefined function.
|
Package jobQueue provides a thread-safe queue of requests to execute a predefined function. |
|
logs
Package logs provides a thin wrapper around the zerolog logging library, enabling structured, context logging across an application.
|
Package logs provides a thin wrapper around the zerolog logging library, enabling structured, context logging across an application. |
|
notifications
Package Notifications provides a client to communicate with the OpenSight Notification Service github.com/greenbone/opensight-notification-service
|
Package Notifications provides a client to communicate with the OpenSight Notification Service github.com/greenbone/opensight-notification-service |
|
openSearch/esextension
Package esextensions provides extensions for https://github.com/aquasecurity/esquery
|
Package esextensions provides extensions for https://github.com/aquasecurity/esquery |
|
openSearch/openSearchClient
Package openSearchClient provides functionality for interacting with OpenSearch.
|
Package openSearchClient provides functionality for interacting with OpenSearch. |
|
openSearch/openSearchQuery
Package openSearchQuery provides a query builder for OpenSearch.
|
Package openSearchQuery provides a query builder for OpenSearch. |
|
postgres/query
Package query facilitates the translation of a result selector into a PostgresSQL conditional query string, incorporating sorting and paging functionalities.
|
Package query facilitates the translation of a result selector into a PostgresSQL conditional query string, incorporating sorting and paging functionalities. |
|
retryableRequest
Package retryableRequest provides a function to retry an http request up to a configured number of retries.
|
Package retryableRequest provides a function to retry an http request up to a configured number of retries. |
|
secretfiles
Package secretfiles eases the parsing of secret files into a string.
|
Package secretfiles eases the parsing of secret files into a string. |
Click to show internal directories.
Click to hide internal directories.