cuda

Documentation

Index

• Constants
• type Admin
• type Admins
• type AdminsSimple
• type Box
• type Boxes
• type BoxesSimple
• type Cluster
• type Clusters
• type ClustersSimple
• type NetworkObject
• type NetworkObjectEntry
• type NetworkObjectExcludedChange
• type NetworkObjectExcludedEntry
• type NetworkObjectExcludedEntryUpdate
• type NetworkObjectGeoChange
• type NetworkObjectGeoEntry
• type NetworkObjectGeoEntryChange
• type NetworkObjectGeoUpdate
• type NetworkObjectIncludedChange
• type NetworkObjectIncludedEntry
• type NetworkObjectIncludedEntryUpdate
• type NetworkObjectType
• type NetworkObjectUpdate
• type NetworkObjects
• type NetworkObjectsSimple
• type Range
• type Ranges
• type RangesSimple
• type Service
• type ServiceObject
• type ServiceObjectEntry
• type ServiceObjectEntryICMP
• type ServiceObjectEntryPortRange
• type ServiceObjectEntryPorts
• type ServiceObjectEntryProtocolProtection
• type Services
• type ServicesSimple
• type Session
• type Sessions

Constants

const (
	// protocol protection actions
	ServiceObjectEntryProtocolProtectionActionNone   = "none"
	ServiceObjectEntryProtocolProtectionActionReport = "report"
	ServiceObjectEntryProtocolProtectionActionReset  = "reset"
	ServiceObjectEntryProtocolProtectionActionDrop   = "drop"

	// protocol protection policies
	ServiceObjectEntryProtocolProtectionPolicyWhitelist = "whitelist"
	ServiceObjectEntryProtocolProtectionPolicyBlacklist = "blacklist"
)

Types

type Admin

type Admin struct {
	Name                  string   `json:"name"`
	FullName              string   `json:"fullName"`
	Enabled               bool     `json:"enabled"`
	Roles                 []string `json:"roles"`
	AuthenticationLevel   string   `json:"authenticationLevel"`
	ExternalLoginName     string   `json:"externalLoginName"`
	EnforcePasswordChange bool     `json:"enforcePasswordChange"`
	GracePeriod           int      `json:"gracePeriod"`
	LoginEvent            string   `json:"loginEvent"`
	NextForcedChange      int      `json:"nextForcedChange"`
	PasswordChangeMode    string   `json:"passwordChangeMode"`
	PasswordValidation    string   `json:"passwordValidation"`
	PeerIPRestriction     []string `json:"peerIpRestriction"`
	PublicKey             string   `json:"publicKey"`
	SystemLevelAccess     string   `json:"systemLevelAccess"`
	WarningPeriod         int      `json:"warningPeriod"`
}

Admins: Box Administrators

type Admins

type Admins struct {
	Admins []Admin `json:"admins"`
}

type AdminsSimple

type AdminsSimple struct {
	Admins []string `json:"admins"` /* user names only */
}

type Box

type Box struct {
	Name                string `json:"name"`
	Enabled             bool   `json:"enabled"`
	IP                  string `json:"ip"`
	Description         string `json:"description"`
	Product             string `json:"product"`
	Model               string `json:"boxModel"`
	Revision            string `json:"revision"`
	ConfTemplate        string `json:"confTemplate,omitempty"`
	ConfTemplateBinding string `json:"confTemplateBinding"`
}

Box

type Boxes

type Boxes struct {
	Boxes []Box `json:"boxes"`
}

type BoxesSimple

type BoxesSimple struct {
	Boxes []string `json:"boxes"`
}

type Cluster

type Cluster struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Version     string `json:"version"`
}

Cluster

type Clusters

type Clusters struct {
	Clusters []Cluster `json:"clusters"`
}

type ClustersSimple

type ClustersSimple struct {
	Clusters []string `json:"clusters"` // cluster names only
}

type NetworkObject

type NetworkObject struct {
	Name        string                       `json:"name"`
	Type        NetworkObjectType            `json:"type"`
	Shared      bool                         `json:"shared"`
	Color       string                       `json:"color,omitempty"`
	Comment     string                       `json:"comment,omitempty"`
	DNSLifetime int                          `json:"dnsLifetime,omitempty"`
	Dynamic     bool                         `json:"dynamic"`
	Included    []NetworkObjectIncludedEntry `json:"included,omitempty"`
	Excluded    []NetworkObjectExcludedEntry `json:"excluded,omitempty"`
	Geo         *NetworkObjectGeoEntry       `json:"geo,omitempty"`
}

The complete network object used by Barracuda for firewall and application rules

type NetworkObjectEntry

type NetworkObjectEntry struct {
	IP        string `json:"ip,omitempty"`
	MAC       string `json:"mac,omitempty"`
	Interface string `json:"interface,omitempty"`
	Comment   string `json:"comment,omitempty"`
}

Network Objects - IPs, references, hostnames, networks

type NetworkObjectExcludedChange

type NetworkObjectExcludedChange struct {
	Add    []NetworkObjectExcludedEntry       `json:"add,omitempty"`
	Remove []string                           `json:"remove,omitempty"`
	Update []NetworkObjectExcludedEntryUpdate `json:"update,omitempty"`
}

type NetworkObjectExcludedEntry

type NetworkObjectExcludedEntry struct {
	Entry *NetworkObjectEntry `json:"entry"`
}

type NetworkObjectExcludedEntryUpdate

type NetworkObjectExcludedEntryUpdate struct {
	Entry *NetworkObjectEntry `json:"entry"`
	ID    string              `json:"id"`
}

type NetworkObjectGeoChange

type NetworkObjectGeoChange struct {
	Add    []string `json:"add,omitempty"`
	Remove []string `json:"remove,omitempty"`
	Update []string `json:"update,omitempty"`
}

type NetworkObjectGeoEntry

type NetworkObjectGeoEntry struct {
	Included []string `json:"included,omitempty"`
	Excluded []string `json:"excluded,omitempty"`
}

type NetworkObjectGeoEntryChange

type NetworkObjectGeoEntryChange struct {
	Included []string `json:"included,omitempty"`
	Excluded []string `json:"excluded,omitempty"`
}

type NetworkObjectGeoUpdate

type NetworkObjectGeoUpdate struct {
	Included []NetworkObjectGeoChange `json:"included,omitempty"`
	Excluded []NetworkObjectGeoChange `json:"excluded,omitempty"`
}

type NetworkObjectIncludedChange

type NetworkObjectIncludedChange struct {
	Add    []NetworkObjectIncludedEntry       `json:"add,omitempty"`
	Remove []string                           `json:"remove,omitempty"`
	Update []NetworkObjectIncludedEntryUpdate `json:"update,omitempty"`
}

type NetworkObjectIncludedEntry

type NetworkObjectIncludedEntry struct {
	Entry      *NetworkObjectEntry `json:"entry,omitempty"`
	References string              `json:"references,omitempty"`
}

type NetworkObjectIncludedEntryUpdate

type NetworkObjectIncludedEntryUpdate struct {
	Entry      *NetworkObjectEntry `json:"entry,omitempty"`
	References string              `json:"references,omitempty"`
	ID         string              `json:"id"`
}

type NetworkObjectType

type NetworkObjectType string

const (
	NetworkObjectTypeGeneric       NetworkObjectType = "generic"
	NetworkObjectTypeFQDN          NetworkObjectType = "hostname"
	NetworkObjectTypeHostname      NetworkObjectType = "hostname"
	NetworkObjectTypeIPv4Address   NetworkObjectType = "singleIPv4Address"
	NetworkObjectTypeIPv6Address   NetworkObjectType = "singleIPv6Address"
	NetworkObjectTypeIPv4Addresses NetworkObjectType = "listIPv4Address"
	NetworkObjectTypeIPv6Addresses NetworkObjectType = "listIPv6Address"
	NetworkObjectTypeIPv4Network   NetworkObjectType = "singleIPv4Network"
	NetworkObjectTypeIPv6Network   NetworkObjectType = "singleIPv6Network"
	NetworkObjectTypeIPv4Networks  NetworkObjectType = "listIPv4Network"
	NetworkObjectTypeIPv6Networks  NetworkObjectType = "listIPv6Network"
)

type NetworkObjectUpdate

type NetworkObjectUpdate struct {
	Name        string                      `json:"name"`
	Type        NetworkObjectType           `json:"type,omitempty"`
	Shared      bool                        `json:"shared"`
	Color       string                      `json:"color,omitempty"`
	Comment     string                      `json:"comment,omitempty"`
	DNSLifetime int                         `json:"dnsLifetime,omitempty"`
	Dynamic     bool                        `json:"dynamic"`
	Included    NetworkObjectIncludedChange `json:"included,omitempty"`
	Excluded    NetworkObjectExcludedChange `json:"excluded,omitempty"`
	Geo         NetworkObjectGeoUpdate      `json:"geo,omitempty"`
}

type NetworkObjects

type NetworkObjects struct {
	NetworkObjects []NetworkObject `json:"objects"`
}

type NetworkObjectsSimple

type NetworkObjectsSimple struct {
	NetworkObjects []string `json:"objects"` /* object names only */
}

type Range

type Range struct {
	Number      string `json:"number"`
	Description string `json:"description"`
}

Range

type Ranges

type Ranges struct {
	Ranges []Range `json:"ranges"`
}

type RangesSimple

type RangesSimple struct {
	Ranges []string `json:"ranges"` // range numbers only
}

type Service

type Service struct {
	Name            string `json:"name"`
	ModuleName      string `json:"moduleName"`
	State           string `json:"state"`
	Processes       int    `json:"processes"`
	FileDescriptors int    `json:"fileDescriptors"`
	Memory          int    `json:"memory"`
	Info            string `json:"info"`
}

type ServiceObject

type ServiceObject struct {
	Color string `json:"color,omitempty"`
}

type ServiceObjectEntry

type ServiceObjectEntry struct {
	BalancedTimeout    int                                  `json:"balancedTimeout,omitempty"`
	Comment            string                               `json:"comment,omitempty"`
	Plugin             string                               `json:"plugin,omitempty"`
	Protocol           string                               `json:"protocol"`
	ICMP               *ServiceObjectEntryICMP              `json:"icmp,omitempty"`
	ProtocolProtection ServiceObjectEntryProtocolProtection `json:"protocolProtection,omitempty"`
	SessionTimeout     int                                  `json:"sessionTimeout,omitempty"`
	TCP                *ServiceObjectEntryPorts             `json:"tcp,omitempty"`
	UDP                *ServiceObjectEntryPorts             `json:"udp,omitempty"`
}

Network Objects - IPs, references, hostnames, networks

type ServiceObjectEntryICMP

type ServiceObjectEntryICMP struct {
	MaxSize  int `json:"maxSize"`
	MinDelay int `json:"minDelay"`
}

type ServiceObjectEntryPortRange

type ServiceObjectEntryPortRange struct {
	From int `json:"from"`
	To   int `json:"to"`
}

type ServiceObjectEntryPorts

type ServiceObjectEntryPorts struct {
	ClientPortsUsed ServiceObjectEntryPortRange `json:"clientPortsUsed,omitempty"`
	DynamicService  string                      `json:"dynamicService,omitempty"`
	Ports           []string                    `json:"ports"`
	ServiceLabel    string                      `json:"serviceLabel,omitempty"`
}

type ServiceObjectEntryProtocolProtection

type ServiceObjectEntryProtocolProtection struct {
	Action    string   `json:"action"`
	Policy    string   `json:"policy"`
	Protocols []string `json:"protocols"`
}

type Services

type Services struct {
	Services []Service `json:"services"`
}

type ServicesSimple

type ServicesSimple struct {
	Services []string `json:"services"`
}

type Session

type Session struct {
	Admin string `json:"admin"`
	Idle  int    `json:"idle"`
	Name  string `json:"name"`
	Peer  string `json:"peer"`
	PID   int    `json:"pid"`
	Type  string `json:"type"`
}

Sessions: Actives sessions within the firewall

type Sessions

type Sessions struct {
	Sessions []Session `json:"sessions"`
}