Documentation
¶
Index ¶
- func CheckBlackListDomain(blacklist *types.DomainList, mu *sync.Mutex) func(*gin.Context)
- func CheckBlackListSubnet(blacklist *types.SubnetList, mu *sync.Mutex) func(*gin.Context)
- func CheckWhiteListDomain(whitelist *types.DomainList, mu *sync.Mutex) func(*gin.Context)
- func CheckWhiteListSubnet(whitelist *types.SubnetList, mu *sync.Mutex) func(*gin.Context)
- func GetBlackListDomains(blacklist *types.DomainList, mu *sync.Mutex) func(*gin.Context)
- func GetBlackListSubnets(blacklist *types.SubnetList, mu *sync.Mutex) func(*gin.Context)
- func GetWhiteListDomains(whitelist *types.DomainList, mu *sync.Mutex) func(*gin.Context)
- func GetWhiteListSubnets(whitelist *types.SubnetList, mu *sync.Mutex) func(*gin.Context)
- func Register(r *gin.Engine, db *database.Database, subnetWhiteList *types.SubnetList, ...)
- func RemoveBlackListDomains(blacklist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- func RemoveBlackListSubnets(blacklist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- func RemoveWhiteListDomains(whitelist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- func RemoveWhiteListSubnets(whitelist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- func UpsertBlackListDomains(blacklist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- func UpsertBlackListSubnets(blacklist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- func UpsertWhiteListDomains(whitelist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- func UpsertWhiteListSubnets(whitelist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
- type CheckDomainResp
- type CheckSubnetResp
- type GetDomainsResp
- type GetSubnetsResp
- type RemoveDomainsReq
- type RemoveSubnetsReq
- type UpsertDomainsReq
- type UpsertSubnetsReq
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckBlackListDomain ¶ added in v0.5.0
CheckBlackListDomain godoc
@Summary Check blacklisted domain
@Description check if a domain is blacklisted
@Tags blacklist
@Produce json
@Param domain path string true "domain to check"
@Success 200 {object} CheckDomainResp
@Router /v1/blacklist/domains/{domain} [get]
func CheckBlackListSubnet ¶ added in v0.5.0
CheckBlackListSubnet godoc
@Summary Check blacklisted subnet
@Description check if a subnet is blacklisted
@Tags blacklist
@Produce json
@Param subnet path string true "subnet to check"
@Success 200 {object} CheckSubnetResp
@Failure 400
@Router /v1/blacklist/subnets/{subnet} [get]
func CheckWhiteListDomain ¶ added in v0.5.0
CheckWhiteListDomain godoc
@Summary Check whitelisted domain
@Description check if a domain is whitelisted
@Tags whitelist
@Produce json
@Param domain path string true "domain to check"
@Success 200 {object} CheckDomainResp
@Router /v1/whitelist/domains/{domain} [get]
func CheckWhiteListSubnet ¶ added in v0.5.0
CheckWhiteListSubnet godoc
@Summary Check whitelisted subnet
@Description check if a subnet is whitelisted
@Tags whitelist
@Produce json
@Param subnet path string true "subnet to check"
@Success 200 {object} CheckSubnetResp
@Failure 400
@Router /v1/whitelist/subnets/{subnet} [get]
func GetBlackListDomains ¶ added in v0.5.0
GetBlackListDomains godoc
@Summary Get blacklisted domains
@Description get all blacklisted domains
@Tags blacklist
@Produce json
@Success 200 {object} GetDomainsResp
@Router /v1/blacklist/domains [get]
func GetBlackListSubnets ¶ added in v0.5.0
GetBlackListSubnets godoc
@Summary Get blacklisted subnets
@Description get all blacklisted subnets
@Tags blacklist
@Produce json
@Success 200 {object} GetSubnetsResp
@Router /v1/blacklist/subnets [get]
func GetWhiteListDomains ¶ added in v0.5.0
GetWhiteListDomains godoc
@Summary Get whitelisted domains
@Description get all whitelisted domains
@Tags whitelist
@Produce json
@Success 200 {object} GetDomainsResp
@Router /v1/whitelist/domains [get]
func GetWhiteListSubnets ¶ added in v0.5.0
GetWhiteListSubnets godoc
@Summary Get whitelisted subnets
@Description get all whitelisted subnets
@Tags whitelist
@Produce json
@Success 200 {object} GetSubnetsResp
@Router /v1/whitelist/subnets [get]
func Register ¶
func Register( r *gin.Engine, db *database.Database, subnetWhiteList *types.SubnetList, subnetBlackList *types.SubnetList, domainWhiteList *types.DomainList, domainBlackList *types.DomainList, )
func RemoveBlackListDomains ¶ added in v0.5.0
func RemoveBlackListDomains(blacklist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
RemoveBlackListDomains godoc
@Summary Remove blacklisted domains @Description remove domains from blacklist @Tags blacklist @Accept json @Param body body RemoveDomainsReq true "domains to remove" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/blacklist/domains [delete]
func RemoveBlackListSubnets ¶ added in v0.5.0
func RemoveBlackListSubnets(blacklist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
RemoveBlackListSubnets godoc
@Summary Remove blacklisted subnets @Description remove subnets from blacklist @Tags blacklist @Accept json @Param body body RemoveSubnetsReq true "subnets to remove" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/blacklist/subnets [delete]
func RemoveWhiteListDomains ¶ added in v0.5.0
func RemoveWhiteListDomains(whitelist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
RemoveWhiteListDomains godoc
@Summary Remove whitelisted domains @Description remove domains from whitelist @Tags whitelist @Accept json @Param body body RemoveDomainsReq true "domains to remove" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/whitelist/domains [delete]
func RemoveWhiteListSubnets ¶ added in v0.5.0
func RemoveWhiteListSubnets(whitelist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
RemoveWhiteListSubnets godoc
@Summary Remove whitelisted subnets @Description remove subnets from whitelist @Tags whitelist @Accept json @Param body body RemoveSubnetsReq true "subnets to remove" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/whitelist/subnets [delete]
func UpsertBlackListDomains ¶ added in v0.5.0
func UpsertBlackListDomains(blacklist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
UpsertBlackListDomains godoc
@Summary Upsert blacklisted domains @Description upsert domains to blacklist @Tags blacklist @Accept json @Param body body UpsertDomainsReq true "domains to add" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/blacklist/domains [post]
func UpsertBlackListSubnets ¶ added in v0.5.0
func UpsertBlackListSubnets(blacklist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
UpsertBlackListSubnets godoc
@Summary Upsert blacklisted subnets @Description upsert subnets to blacklist @Tags blacklist @Accept json @Param body body UpsertSubnetsReq true "subnets to add" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/blacklist/subnets [post]
func UpsertWhiteListDomains ¶ added in v0.5.0
func UpsertWhiteListDomains(whitelist *types.DomainList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
UpsertWhiteListDomains godoc
@Summary Upsert whitelisted domains @Description upsert domains to whitelist @Tags whitelist @Accept json @Param body body UpsertDomainsReq true "domains to add" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/whitelist/domains [post]
func UpsertWhiteListSubnets ¶ added in v0.5.0
func UpsertWhiteListSubnets(whitelist *types.SubnetList, mu *sync.Mutex, db *database.Database) func(*gin.Context)
UpsertWhiteListSubnets godoc
@Summary Upsert whitelisted subnets @Description upsert subnets to whitelist @Tags whitelist @Accept json @Param body body UpsertSubnetsReq true "subnets to add" @Success 202 @Failure 400 @Failure 422 @Failure 500 @Router /v1/whitelist/subnets [post]
Types ¶
type CheckDomainResp ¶ added in v0.5.0
type CheckDomainResp struct {
Found bool `json:"found"`
}
type CheckSubnetResp ¶ added in v0.5.0
type CheckSubnetResp struct {
Found bool `json:"found"`
}
type GetDomainsResp ¶ added in v0.5.0
type GetDomainsResp struct {
Domains []string `json:"domains"`
}
type GetSubnetsResp ¶ added in v0.5.0
type GetSubnetsResp struct {
Subnets []string `json:"subnets"`
}
type RemoveDomainsReq ¶ added in v0.5.0
type RemoveDomainsReq struct {
Domains []string `json:"domains"`
}
type RemoveSubnetsReq ¶ added in v0.5.0
type RemoveSubnetsReq struct {
Subnets []string `json:"subnets"`
}
type UpsertDomainsReq ¶ added in v0.5.0
type UpsertDomainsReq struct {
Domains []string `json:"domains"`
}
type UpsertSubnetsReq ¶ added in v0.5.0
type UpsertSubnetsReq struct {
Subnets []string `json:"subnets"`
}
Source Files
Click to show internal directories.
Click to hide internal directories.