config

type BrandingFormat string

type Config struct {
	// contains filtered or unexported fields
}

type DisabledUsers struct {

	// File is the fully-qualified path to the EZproxy include file where this
	// application should write disabled user accounts.
	File *string `` /* 190-byte string literal not displayed */

	// EntrySuffix is the string that is appended after every username added
	// to the disabled users file in order to deny login access.
	EntrySuffix *string `` /* 213-byte string literal not displayed */

	// Permissions is the desired file permissions when this file is created.
	// Note: The ezproxy daemon will need to be able to read this file.
	FilePermissions *os.FileMode `` /* 223-byte string literal not displayed */
}

type EZproxy struct {

	// ExecutablePath is the fully-qualified path to the EZproxy
	// executable/binary. This executable is usually named 'ezproxy' and is
	// set to start at system boot. The fully-qualified path to this
	// executable is required for session termination.
	ExecutablePath *string `` /* 314-byte string literal not displayed */

	// ActiveFilePath is the fully-qualified path to the Active Users and
	// Hosts "state" file used by EZproxy (and this application) to track
	// current sessions and hosts managed by EZproxy.
	ActiveFilePath *string `` /* 261-byte string literal not displayed */

	// AuditFileDirPath is the path to the directory containing the EZproxy
	// audit files. The assumption is made that all files within are based on
	// YYYYMMDD.txt pattern. Any other file pattern found within this path is
	// ignored (e.g, .zip or .tar or whatnot for a one-off quick backup made
	// by a sysadmin of a specific file).
	AuditFileDirPath *string `` /* 403-byte string literal not displayed */

	// SearchRetries is the number of retries allowed for the audit log and
	// active files before the application accepts that "cannot find matching
	// session IDs for specific user" is really the truth of it and not a race
	// condition between this application and the EZproxy application (e.g.,
	// EZproxy accepts a login, but delays writing the state information for
	// about 2 seconds to keep from hammering the storage device).
	SearchRetries *int `` /* 487-byte string literal not displayed */

	// SearchDelay is the delay in seconds between searches of the audit log
	// or active file for a specified username. This is an attempt to work
	// around race conditions between EZproxy updating its state file (which
	// has been observed to have a delay of up to several seconds) and this
	// application *reading* the active file. This delay is applied to the
	// initial search and each subsequent retried search for the provided
	// username.
	SearchDelay *int `` /* 493-byte string literal not displayed */

	// TerminateSessions controls whether session termination support is
	// enabled.
	//
	// If false, session termination will not be initiated by this
	// application, though current session IDs found as part of preparing for
	// termination will still be logged for troubleshooting purposes.
	//
	// If setting (or leaving) this as false, the assumption is that either no
	// handling of reported users is desired (other than perhaps logging and
	// notification) or that a tool such as fail2ban is used to monitor the
	// reported users log file and temporarily block the source IP in order to
	// force session timeout.
	TerminateSessions *bool `` /* 656-byte string literal not displayed */
}

type Email struct {

	// Server is the SMTP server that this application should connect to for
	// email message delivery. Specify localhost if testing or sending mail
	// via a local SMTP server instance. Examples include running a Postfix
	// null client which sends all mail to a relayhost on the local network or
	// a Maildev Docker container for development purposes.
	Server *string `` /* 397-byte string literal not displayed */

	// Port is the TCP port that this application should connect to for email
	// message delivery. The default is usually 25, but could be 1025 if using
	// the default Maildev container port.
	Port *int `` /* 243-byte string literal not displayed */

	// ClientIdentity is the hostname provided with the HELO or EHLO greeting
	// to the SMTP server. Be aware that many SMTP servers expect this value
	// to be a valid FQDN with forward and reverse DNS records. If left blank,
	// this value is generated by retrieving the local system's
	// fully-qualified domain name, the local hostname or as a fallback, the
	// hard-coded default value.
	ClientIdentity *string `` /* 439-byte string literal not displayed */

	// SenderAddress is the email address used as the sender for all outgoing
	// email notifications from this application.
	SenderAddress *string `` /* 185-byte string literal not displayed */

	// RecipientAddresses is the comma or space-separated list of email
	// addresses that should receive all outgoing email notifications from
	// this application.
	RecipientAddresses []string `` /* 232-byte string literal not displayed */

	// RateLimit is the number of seconds to wait between email notification
	// attempts. This rate limit is intended to help prevent unintentional
	// abuse of remote services and is applied regardless of whether the last
	// notification attempt was initially successful or required one or more
	// retry attempts.
	RateLimit *int `` /* 372-byte string literal not displayed */

	// RetryDelay is the number of seconds to wait between email message
	// delivery attempts.
	RetryDelay *int `` /* 170-byte string literal not displayed */

	// Retries is the number of attempts that this application will make to
	// deliver email messages before giving up.
	Retries *int `` /* 180-byte string literal not displayed */
}

type IgnoredIPAddresses struct {

	// File is the fully-qualified path to the file containing a list of
	// individual IP Addresses which should not be banned by this application.
	File *string `` /* 338-byte string literal not displayed */
}

type IgnoredUsers struct {

	// File is the fully-qualified path to the file containing a list of user
	// accounts that should not be disabled.
	File *string `` /* 321-byte string literal not displayed */
}

type Logging struct {
	// Level is the chosen logging level
	Level *string `` /* 131-byte string literal not displayed */

	// Output is one of the standard application outputs, stdout or stderr
	Output *string `toml:"output" arg:"--log-output,env:BRICK_LOG_OUTPUT" help:"Log messages are written to this output target."`

	// LogFormat controls which output format is used for log messages
	// generated by this application. This value is from a smaller subset
	// of the formats supported by the third-party leveled-logging package
	// used by this application.
	Format *string `toml:"format" arg:"--log-format,env:BRICK_LOG_FORMAT" help:"Log messages are written in this format."`
}

type MSTeams struct {

	// WebhookURL is the full URL used to submit messages to the Teams
	// channel. This URL is in the form of
	// https://outlook.office.com/webhook/xxx or
	// https://outlook.office365.com/webhook/xxx. This URL needs to be created
	// in advance by adding/configuring a Webhook Connector in a Microsoft
	// Teams channel that you wish to submit messages to using this
	// application.
	WebhookURL *string `` /* 275-byte string literal not displayed */

	// RateLimit is the number of seconds to wait between Microsoft Teams
	// notification attempts. This rate limit is intended to help prevent
	// unintentional abuse of remote services and is applied regardless of
	// whether the last notification attempt was initially successful or
	// required one or more retry attempts.
	RateLimit *int `` /* 385-byte string literal not displayed */

	// RetryDelay is the number of seconds to wait between Microsoft Teams
	// message delivery retry attempts.
	RetryDelay *int `` /* 183-byte string literal not displayed */

	// Retries is the number of attempts that this application will make to
	// deliver Microsoft Teams messages before giving up.
	Retries *int `` /* 193-byte string literal not displayed */
}

type Network struct {

	// LocalTCPPort is the TCP port that this application should listen on for
	// incoming requests
	LocalTCPPort *int `` /* 142-byte string literal not displayed */

	// LocalIPAddress is the IP Address that this application should listen on
	// for incoming requests
	LocalIPAddress *string `` /* 160-byte string literal not displayed */

	// TrustedIPAddresses is the collection of single IP Addresses which are
	// trusted for payload submission. If this is defined, all other sender
	// IPs are ignored. If this is not defined, payloads are accepted from all
	// IP Addresses not otherwise rejected by local/remote firewall rules.
	TrustedIPAddresses []string `` /* 345-byte string literal not displayed */
}

type ReportedUsers struct {

	// File is the fully-qualified path to the log file where this application
	// should log user disable request events for fail2ban to ingest.
	LogFile *string `` /* 212-byte string literal not displayed */

	// Permissions is the desired file permissions when this file is created.
	// Note: fail2ban will need to be able to read this file.
	LogFilePermissions *os.FileMode `` /* 221-byte string literal not displayed */
}