cli

package
Version: v0.0.0-...-177ba06 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2022 License: MIT Imports: 41 Imported by: 2

Documentation

Index

Constants

View Source
const (
	//RA Summary: gosec - G101 - Password Management: Hardcoded Password
	//RA: This line was flagged because of use of the word "secret"
	//RA: This line is used to identify the name of the flag. ClientAuthSecretKeyFlag is the Client Auth Secret Key Flag.
	//RA: This value of this variable does not store an application secret.
	//RA Developer Status: Mitigated
	//RA Validator Status: Mitigated
	//RA Validator: jneuner@mitre.org
	//RA Modified Severity: CAT III
	// #nosec G101
	// ClientAuthSecretKeyFlag is the Client Auth Secret Key Flag
	ClientAuthSecretKeyFlag string = "client-auth-secret-key"
	// LoginGovCallbackProtocolFlag is the Login.gov Callback Protocol Flag
	LoginGovCallbackProtocolFlag string = "login-gov-callback-protocol"
	// LoginGovCallbackPortFlag is the Login.gov Callback Port Flag
	LoginGovCallbackPortFlag string = "login-gov-callback-port"
	// LoginGovSecretKeyFlag is the Login.gov Secret Key Flag
	LoginGovSecretKeyFlag string = "login-gov-secret-key"
	// LoginGovMyClientIDFlag is the Login.gov My Client ID Flag
	LoginGovMyClientIDFlag string = "login-gov-my-client-id"
	// LoginGovOfficeClientIDFlag is the Login.gov Office Client ID Flag
	LoginGovOfficeClientIDFlag string = "login-gov-office-client-id"
	// LoginGovAdminClientIDFlag is the Login.gov Admin Client ID Flag
	LoginGovAdminClientIDFlag string = "login-gov-admin-client-id"
	// LoginGovHostnameFlag is the Login.gov Hostname Flag
	LoginGovHostnameFlag string = "login-gov-hostname"
)

Set of flags used for authentication

View Source
const (
	// BuildRootFlag is the build root flag
	BuildRootFlag string = "build-root"

	// DefaultBuildRoot Path to the build directory
	DefaultBuildRoot string = "build"
)
View Source
const (
	// CACFlag indicates that a CAC should be used
	CACFlag string = "cac"
	// PKCS11ModuleFlag is the location of the PCKS11 module to use with the smart card
	PKCS11ModuleFlag string = "pkcs11module"
	// TokenLabelFlag is the Token Label to use with the smart card
	TokenLabelFlag string = "tokenlabel"
	// CertLabelFlag is the Certificate Label to use with the smart card
	CertLabelFlag string = "certlabel"
	// KeyLabelFlag is the Key Label to use with the smart card
	KeyLabelFlag string = "keylabel"
)
View Source
const (
	// DevlocalCAFlag is the Devlocal CA Flag
	DevlocalCAFlag string = "devlocal-ca"
	// DoDCAPackageFlag is the DoD CA Package Flag
	DoDCAPackageFlag string = "dod-ca-package"
	// MoveMilDoDCACertFlag is the Move.mil DoD CA Cert Flag
	MoveMilDoDCACertFlag string = "move-mil-dod-ca-cert"
	// MoveMilDoDTLSCertFlag is the Move.mil DoD TLS Cert Flag
	MoveMilDoDTLSCertFlag string = "move-mil-dod-tls-cert"
	// MoveMilDoDTLSKeyFlag is the Move.mil DoD TLS Key Flag
	MoveMilDoDTLSKeyFlag string = "move-mil-dod-tls-key"
)
View Source
const (
	// EntrustL1KCertFlag is the Entrust L1K Cert Flag
	EntrustL1KCertFlag string = "entrust-l1k-cert"
	// EntrustG2CertFlag is the Entrust G2 Cert Flag
	EntrustG2CertFlag string = "entrust-g2-cert"
)
View Source
const (
	// DbDebugFlag is the DB Debug flag
	DbDebugFlag string = "db-debug"
	// DbEnvFlag is the DB environment flag
	DbEnvFlag string = "db-env"
	// DbNameFlag is the DB name flag
	DbNameFlag string = "db-name"
	// DbHostFlag is the DB host flag
	DbHostFlag string = "db-host"
	// DbPortFlag is the DB port flag
	DbPortFlag string = "db-port"
	// DbUserFlag is the DB user flag
	DbUserFlag string = "db-user"
	// DbPasswordFlag is the DB password flag
	DbPasswordFlag string = "db-password"
	// DbPoolFlag is the DB pool flag
	DbPoolFlag string = "db-pool"
	// DbIdlePoolFlag is the DB idle pool flag
	DbIdlePoolFlag string = "db-idle-pool"
	// DbSSLModeFlag is the DB SSL Mode flag
	DbSSLModeFlag string = "db-ssl-mode"
	// DbSSLRootCertFlag is the DB SSL Root Cert flag
	DbSSLRootCertFlag string = "db-ssl-root-cert"
	// DbIamFlag is the DB IAM flag
	DbIamFlag string = "db-iam"
	// DbIamRoleFlag is the DB IAM Role flag
	DbIamRoleFlag string = "db-iam-role"
	// DbRegionFlag is the DB Region flag
	DbRegionFlag string = "db-region"
	// DbUseInstrumentedDriverFlag indicates if additional db
	// instrumentation should be done
	DbInstrumentedFlag = "db-instrumented"

	// DbEnvContainer is the Container DB Env name
	DbEnvContainer string = "container"
	// DbEnvTest is the Test DB Env name
	DbEnvTest string = "test"
	// DbEnvDevelopment is the Development DB Env name
	DbEnvDevelopment string = "development"

	// DbNameTest The name of the test database
	DbNameTest string = "test_db"

	// SSLModeDisable is the disable SSL Mode
	SSLModeDisable string = "disable"
	// SSLModeAllow is the allow SSL Mode
	SSLModeAllow string = "allow"
	// SSLModePrefer is the prefer SSL Mode
	SSLModePrefer string = "prefer"
	// SSLModeRequire is the require SSL Mode
	SSLModeRequire string = "require"
	// SSLModeVerifyCA is the verify-ca SSL Mode
	SSLModeVerifyCA string = "verify-ca"
	// SSLModeVerifyFull is the verify-full SSL Mode
	SSLModeVerifyFull string = "verify-full"

	// DbPoolDefault is the default db pool connections
	DbPoolDefault = awsRdsT3SmallMaxConnections
	// DbIdlePoolDefault is the default db idle pool connections
	DbIdlePoolDefault = 2
	// DbPoolMax is the upper limit the db pool can use for connections which constrains the user input
	DbPoolMax int = awsRdsT3SmallMaxConnections
)
View Source
const (
	// DbRetryIntervalFlag is the DB retry interval flag
	DbRetryIntervalFlag string = "db-retry-interval"
	// DbRetryMaxFlag is the DB retry maximum flag
	DbRetryMaxFlag string = "db-retry-max"
)
View Source
const (
	// HTTPSDDCServerNameFlag is the HTTP SDDC Server Name Flag
	HTTPSDDCServerNameFlag string = "http-sddc-server-name"
	// HTTPSDDCProtocolFlag is the HTTP SDDC Protocol Flag
	HTTPSDDCProtocolFlag string = "http-sddc-protocol"
	// HTTPSDDCPortFlag is the HTTP SDDC Port Flag
	HTTPSDDCPortFlag string = "http-sddc-port"
	// HTTPDPSServerNameFlag is the HTTP DPS Server Name Flag
	HTTPDPSServerNameFlag string = "http-dps-server-name"

	//RA Summary: gosec - G101 - Password Management: Hardcoded Password
	//RA: This line was flagged because of use of the word "secret"
	//RA: This line is used to identify the name of the flag. DPSAuthSecretKeyFlag is the DPS Auth Secret Key Flag.
	//RA: This variable does not store an application secret.
	//RA Developer Status: Mitigated
	//RA Validator Status: Mitigated
	//RA Validator: jneuner@mitre.org
	//RA Modified Severity: CAT III
	// #nosec G101
	// DPSAuthSecretKeyFlag is the DPS Auth Secret Key Flag
	DPSAuthSecretKeyFlag string = "dps-auth-secret-key"
	// DPSRedirectURLFlag is the DPS Redirect URL Flag
	DPSRedirectURLFlag string = "dps-redirect-url"
	// DPSCookieNameFlag is the DPS Cookie Name Flag
	DPSCookieNameFlag string = "dps-cookie-name"
	// DPSCookieDomainFlag is the DPS Cookie Domain Flag Flag
	DPSCookieDomainFlag string = "dps-cookie-domain"

	//RA Summary: gosec - G101 - Password Management: Hardcoded Password
	//RA: This line was flagged because of use of the word "secret"
	//RA: This line is used to identify the name of the flag. DPSAuthCookieSecretKeyFlag is the DPS Auth Cookie Secret Key Flag
	//RA: The value of this variable does not store an application secret.
	//RA Developer Status: Mitigated
	//RA Validator Status: Mitigated
	//RA Validator: jneuner@mitre.org
	//RA Modified Severity: CAT III
	// #nosec G101
	// DPSAuthCookieSecretKeyFlag is the DPS Auth Cookie Secret Key Flag
	DPSAuthCookieSecretKeyFlag string = "dps-auth-cookie-secret-key"
	// DPSCookieExpiresInMinutesFlag is the DPS Cookie Expires In Minutes Flag
	DPSCookieExpiresInMinutesFlag string = "dps-cookie-expires-in-minutes"
)

Set of flags used for DPS system

View Source
const (
	// EIAKeyFlag is the EIA Key Flag
	EIAKeyFlag string = "eia-key"
	// EIAURLFlag is the EIA URL Flag
	EIAURLFlag string = "eia-url"
)
View Source
const (
	// EmailBackendFlag is the Email Backend Flag
	EmailBackendFlag string = "email-backend"
	// AWSSESRegionFlag is the AWS SES Region Flag
	AWSSESRegionFlag string = "aws-ses-region"
	// AWSSESDomainFlag is the AWS SES Domain Flag
	AWSSESDomainFlag string = "aws-ses-domain"
	// SysAdminEmail is flag for the System Administrators' email
	SysAdminEmail string = "sys-admin-email"
)
View Source
const (
	// EnvironmentFlag is the Environment Flag
	EnvironmentFlag string = "environment"

	// ReviewBaseDomainFlag is the base domain name for review apps
	ReviewBaseDomainFlag = "review-base-domain"
	// ReviewBaseDomainDefault is the default base domain for review apps
	ReviewBaseDomainDefault = "review.localhost"

	// EnvironmentProd is the Production Environment name
	EnvironmentProd string = "prod"
	// EnvironmentStaging is the Staging Environment name
	EnvironmentStaging string = "staging"
	// EnvironmentExperimental is the Experimental Environment name
	EnvironmentExperimental string = "experimental"
	// EnvironmentTest is the Test Environment name
	EnvironmentTest string = "test"
	// EnvironmentDevelopment is the Development Environment name
	EnvironmentDevelopment string = "development"
	// EnvironmentDemo is the GovCloud demo Environment name
	EnvironmentDemo string = "demo"
	// EnvironmentLoadtest is the GovCloud loadtest Environment name
	EnvironmentLoadtest string = "loadtest"
	// EnvironmentExp is the GovCloud exp Environment name
	EnvironmentExp string = "exp"
	// EnvironmentStg is the GovCloud stg Environment name
	EnvironmentStg string = "stg"
	// EnvironmentPrd is the GovCloud prd Environment name
	EnvironmentPrd string = "prd"
	// EnvironmentReview is a reviewapp
	EnvironmentReview string = "review"
)
View Source
const (
	// GEXBasicAuthUsernameFlag is the GEX Basic Auth Username Flag
	GEXBasicAuthUsernameFlag string = "gex-basic-auth-username"
	//RA Summary: gosec - G101 - Password Management: Hardcoded Password
	//RA: This line was flagged because of use of the word "password"
	//RA: This line is used to identify the name of the flag. GEXBasicAuthPasswordFlag is the GEX Basic Auth Password Flag.
	//RA: This value of this variable does not store an application password.
	//RA Developer Status: Mitigated
	//RA Validator Status: Mitigated
	//RA Validator: jneuner@mitre.org
	//RA Modified Severity: CAT III
	// #nosec G101
	// GEXBasicAuthPasswordFlag is the GEX Basic Auth Password Flag
	GEXBasicAuthPasswordFlag string = "gex-basic-auth-password"
	// GEXSendProdInvoiceFlag is the GEX Send Prod Invoice Flag
	GEXSendProdInvoiceFlag string = "gex-send-prod-invoice"
	// GEXURLFlag is the GEX URL FLag
	GEXURLFlag string = "gex-url"
	// SendToSyncada is the flag to control if we try sending files to syncada or not
	SendToSyncada string = "send-to-syncada"
)

Set of flags used for GEX

View Source
const (
	// GEXSFTPPortFlag is the ENV var for the GEX SFTP port
	GEXSFTPPortFlag string = "gex-sftp-port"
	// GEXSFTPUserIDFlag is the ENV var for the GEX SFTP user ID
	GEXSFTPUserIDFlag string = "gex-sftp-user-id"
	// GEXSFTPIPAddressFlag is the ENV var for the GEX SFTP IP address
	GEXSFTPIPAddressFlag string = "gex-sftp-ip-address"
	//RA Summary: gosec - G101 - Password Management: Hardcoded Password
	//RA: This line was flagged because of use of the word "password"
	//RA: This line is used to identify the name of the flag. GEXSFTPPasswordFlag is the GEX SFTP Password Flag.
	//RA: See MB-7727 and MB-7728 for tracking future work to resolve this issue
	//RA: App should implement public-key authentication; issue remains open while interface control is negotiated for this connection.
	//RA Developer Status: Mitigated
	//RA Validator Status: Known Issue
	//RA Validator: leodis.f.scott.civ@mail.mil
	//RA Modified Severity: CAT III
	// #nosec G101
	// GEXSFTPPasswordFlag is the ENV var for the GEX SFTP password
	GEXSFTPPasswordFlag string = "gex-sftp-password"
	// GEXSFTPHostKeyFlag is the ENV var for the GEX SFTP host key
	GEXSFTPHostKeyFlag string = "gex-sftp-host-key"
	// GEXSFTP997PickupDirectory is the ENV var for the directory where GEX delivers responses
	GEXSFTP997PickupDirectory string = "gex-sftp-997-pickup-directory"
	// GEXSFTP824PickupDirectory is the ENV var for the directory where GEX delivers responses
	GEXSFTP824PickupDirectory string = "gex-sftp-824-pickup-directory"
)

Set of flags used for GEXSFTP

View Source
const (
	// HTTPMyServerNameFlag is the HTTP My Server Name Flag
	HTTPMyServerNameFlag string = "http-my-server-name"
	// HTTPOfficeServerNameFlag is the HTTP Office Server Name Flag
	HTTPOfficeServerNameFlag string = "http-office-server-name"
	// HTTPAdminServerNameFlag is the HTTP Admin Server Name Flag
	HTTPAdminServerNameFlag string = "http-admin-server-name"
	// HTTPOrdersServerNameFlag is the HTTP Orders Server Name Flag
	HTTPOrdersServerNameFlag string = "http-orders-server-name"
	// HTTPPrimeServerNameFlag is the HTTP GHC Prime Server Name Flag
	HTTPPrimeServerNameFlag string = "http-prime-server-name"
	// HTTPMyServerNameLocal is the HTTP My Server Name for Local
	HTTPMyServerNameLocal string = "milmovelocal"
	// HTTPOfficeServerNameLocal is the HTTP Office Server Name for Local
	HTTPOfficeServerNameLocal string = "officelocal"
	// HTTPAdminServerNameLocal is the HTTP Admin Server Name for Local
	HTTPAdminServerNameLocal string = "adminlocal"
	// HTTPOrdersServerNameLocal is the HTTP Orders Server Name for Local
	HTTPOrdersServerNameLocal string = "orderslocal"
	// HTTPPrimeServerNameLocal is the HTTP GHC Prime Server Name for Local
	HTTPPrimeServerNameLocal string = "primelocal"
)
View Source
const (
	// IWSRBSHostFlag is the IWS RBS Host Flag
	IWSRBSHostFlag string = "iws-rbs-host"
	// IWSRBSEnabledFlag is the IWS RBS Enabled Flag
	IWSRBSEnabledFlag string = "iws-rbs-enabled"
)
View Source
const (
	// MutualTLSListenerFlag is the Mutual TLS Listener Flag
	MutualTLSListenerFlag string = "mutual-tls-enabled"
	// TLSListenerFlag is the TLS Listener Flag
	TLSListenerFlag string = "tls-enabled"
	// NoTLSListenerFlag is the No TLS Listener Flag
	NoTLSListenerFlag string = "no-tls-enabled"
)
View Source
const (
	// LoggingEnvFlag is the logging environment flag
	LoggingEnvFlag string = "logging-env"
	// LogTaskMetadataFlag is the Log Task Metadata Flag
	LogTaskMetadataFlag string = "log-task-metadata"
	// LoggingLevelFlag is the flag that defines the logging level
	// Possible values are: fatal, error, warn, info, debug
	// The env var value is not case-sensitive. This works:
	// export LOGGING_LEVEL=INFO
	LoggingLevelFlag string = "logging-level"
	// StacktraceLengthFlag is the flag that defines the number of lines to
	// print in a stack trace
	// Example: export STACKTRACE_LENGTH=10
	StacktraceLengthFlag string = "stacktrace-length"

	// LoggingEnvProduction is the production logging environment
	LoggingEnvProduction string = "production"
	// LoggingEnvDevelopment is the development logging environment
	LoggingEnvDevelopment string = "development"

	// LoggingLevelFatal is the fatal logging level
	LoggingLevelFatal string = "fatal"
	// LoggingLevelError is the error logging level
	LoggingLevelError string = "error"
	// LoggingLevelWarn is the warn logging level
	LoggingLevelWarn string = "warn"
	// LoggingLevelInfo is the info logging level
	LoggingLevelInfo string = "info"
	// LoggingLevelDebug is the debug logging level
	LoggingLevelDebug string = "debug"
)
View Source
const (
	// MaxBodySizeFlag is the maximum body size for requests
	MaxBodySizeFlag string = "max-body-size"

	// MaxBodySizeDefault is 20 mb
	MaxBodySizeDefault int64 = 200 * 1000 * 1000
)
View Source
const (
	// MigrationManifestFlag is the migration manifest flag
	MigrationManifestFlag string = "migration-manifest"
	// MigrationWaitFlag is the migration wait flag
	MigrationWaitFlag string = "migration-wait"
)
View Source
const (
	// MigrationVersionFlag is the migration version flag
	MigrationVersionFlag string = "version"
	// MigrationNameFlag is the migration name flag
	MigrationNameFlag string = "name"
	// MigrationTypeFlag is the migration manifest flag
	MigrationTypeFlag string = "type"
	// VersionTimeFormat is the Go time format for creating a version number.
	VersionTimeFormat string = "20060102150405"
)
View Source
const (
	// MutualTLSPortFlag is the Mutual TLS Port Flag
	MutualTLSPortFlag string = "mutual-tls-port"
	// TLSPortFlag is the TLS Port Flag
	TLSPortFlag string = "tls-port"
	// NoTLSPortFlag is the No TLS Port Flag
	NoTLSPortFlag string = "no-tls-port"

	// MutualTLSPort is the default port for mTLS traffic
	MutualTLSPort int = 9443
	// TLSPort is the default port for TLS traffic
	TLSPort int = 8443
	// NoTLSPort is the default port in develompent for HTTP traffic
	NoTLSPort int = 8080
)
View Source
const (
	// RedisPasswordFlag is the ENV var for the Redis password
	RedisPasswordFlag string = "redis-password"
	// RedisHostFlag is the ENV var for the Redis hostname
	RedisHostFlag string = "redis-host"
	// RedisPortFlag is the ENV var for the Redis port
	RedisPortFlag string = "redis-port"
	// RedisDBNameFlag is the ENV var for the Redis database name, which
	// is represented by a positive integer. Using multiple databases in
	// the same Redis instance allows separating concerns.
	RedisDBNameFlag string = "redis-db-name"
	// RedisConnectTimeoutFlag specifies how long to wait to establish a
	// connection to the Redis instance
	RedisConnectTimeoutFlag string = "redis-connect-timeout-in-seconds"
	// RedisEnabledFlag specifies whether or not we attempt to connect
	// to Redis. For example, apps that use mTLS don't need Redis.
	RedisEnabledFlag string = "redis-enabled"
	// RedisSSLEnabledFlag specifies if SSL mode is enabled for connections
	RedisSSLEnabledFlag string = "redis-ssl-enabled"
	// RedisMaxIdleFlag specifies the maximum number of idle connections in the pool
	RedisMaxIdleFlag string = "redis-max-idle"
	// RedisIdleTimeoutFlag Closes connections after this duration
	RedisIdleTimeoutFlag string = "redis-idle-timeout"
)
View Source
const (
	// HEREMapsGeocodeEndpointFlag is the HERE Maps Geocode Endpoint Flag
	HEREMapsGeocodeEndpointFlag string = "here-maps-geocode-endpoint"
	// HEREMapsRoutingEndpointFlag is the HERE Maps Routing Endpoint Flag
	HEREMapsRoutingEndpointFlag string = "here-maps-routing-endpoint"
	// HEREMapsAppIDFlag is the HERE Maps App ID Flag
	HEREMapsAppIDFlag string = "here-maps-app-id"
	// HEREMapsAppCodeFlag is the HERE Maps App Code Flag
	HEREMapsAppCodeFlag string = "here-maps-app-code"

	// DTODApiUsernameFlag is the DTOD API Username Flag
	DTODApiUsernameFlag string = "dtod-api-username"
	// DTODApiPasswordFlag is the DTOD API Password Flag
	DTODApiPasswordFlag string = "dtod-api-password"
	// DTODApiURLFlag is the DTOD API URL Flag
	DTODApiURLFlag string = "dtod-api-url"
	// DTODApiWSDLFlag is the DTOD API WSDL Flag
	DTODApiWSDLFlag string = "dtod-api-wsdl"
)
View Source
const (
	// ServeAdminFlag is the admin service flag
	ServeAdminFlag string = "serve-admin"
	// ServeSDDCFlag is the sddc service flag
	ServeSDDCFlag string = "serve-sddc"
	// ServeOrdersFlag is the orders service flag
	ServeOrdersFlag string = "serve-orders"
	// ServeDPSFlag is the DPS service flag
	ServeDPSFlag string = "serve-dps"
	// ServeAPIInternalFlag is the internal api service flag
	ServeAPIInternalFlag string = "serve-api-internal"
	// ServeGHCFlag is the ghc api service flag
	ServeGHCFlag string = "serve-api-ghc"
	// ServePrimeFlag is the prime api flag
	ServePrimeFlag string = "serve-api-prime"
	// ServeSupportFlag is the support api flag
	ServeSupportFlag string = "serve-api-support"
	// ServePrimeSimulatorFlag is the prime simulator api flag
	ServePrimeSimulatorFlag string = "serve-prime-simulator"
)
View Source
const (
	// SessionIdleTimeoutInMinutesFlag sets the session's Idle Timeout in minutes
	SessionIdleTimeoutInMinutesFlag string = "session-idle-timeout-in-minutes"
	// SessionLifetimeInHoursFlag sets the session's absolute expiry in hours
	SessionLifetimeInHoursFlag string = "session-lifetime-in-hours"
)
View Source
const (
	// StorageBackendFlag is the Storage Backend Flag
	StorageBackendFlag string = "storage-backend"
	// LocalStorageRootFlag is the Local Storage Root Flag
	LocalStorageRootFlag string = "local-storage-root"
	// LocalStorageWebRootFlag is the Local Storage WebRoot Flag
	LocalStorageWebRootFlag string = "local-storage-web-root"
	// AWSS3BucketNameFlag is the AWS S3 Bucket Name Flag
	AWSS3BucketNameFlag string = "aws-s3-bucket-name"
	// AWSS3RegionFlag is the AWS S3 Region Flag
	AWSS3RegionFlag string = "aws-s3-region"
	// AWSS3KeyNamespaceFlag is the AWS S3 Key Namespace Flag
	AWSS3KeyNamespaceFlag string = "aws-s3-key-namespace"
)
View Source
const (
	// SwaggerFlag is the Public Swagger Flag
	SwaggerFlag string = "swagger"
	// InternalSwaggerFlag is the Internal Swagger Flag
	InternalSwaggerFlag string = "internal-swagger"
	// OrdersSwaggerFlag is the Orders Swagger Flag
	OrdersSwaggerFlag string = "orders-swagger"
	// DPSSwaggerFlag is the DPS Swagger Flag
	DPSSwaggerFlag string = "dps-swagger"
	// AdminSwaggerFlag is the Admin Swagger Flag
	AdminSwaggerFlag string = "admin-swagger"
	// GHCSwaggerFlag is the GHC Swagger Flag
	GHCSwaggerFlag string = "ghc-swagger"
	// PrimeSwaggerFlag is the Prime Swagger Flag
	PrimeSwaggerFlag string = "prime-swagger"
	// ServeSwaggerUIFlag is the Serve Swagger UI Flag
	ServeSwaggerUIFlag string = "serve-swagger-ui"
	// SupportSwaggerFlag is the Support Swagger Flag
	SupportSwaggerFlag string = "support-swagger"
)
View Source
const (
	// TelemetryEnabledFlag is the Trace Enable Flag
	TelemetryEnabledFlag string = "telemetry-enabled"
	// TelemetryEndpointFlag configures the endpoint used for open
	// telemetry tracing
	TelemetryEndpointFlag string = "telemetry-endpoint"
	// TelemetryUseXrayIDFlag enables using AWS Xray Trace IDs for open telemetry
	TelemetryUseXrayIDFlag string = "telemetry-use-xray-id"
	// TelemetrySamplingFractionFlag configures the percent of traces to sample
	TelemetrySamplingFractionFlag string = "telemetry-sampling-fraction"
	// TelemetryCollectSecondsFlag configures the metric collection
	// period in seconds
	TelemetryCollectSecondsFlag string = "telemetry-collect-seconds"
	// TelemetryReadEventsEnabledFlag enables read events
	TelemetryReadEventsEnabledFlag string = "telemetry-read-events-enabled"
	// TelemetryWriteEventsEnabledFlag enables write events
	TelemetryWriteEventsEnabledFlag string = "telemetry-write-events-enabled"
)
View Source
const (
	// VaultAWSKeychainNameFlag is the aws-vault keychain name Flag
	VaultAWSKeychainNameFlag string = "aws-vault-keychain-name"
	// VaultAWSProfileFlag is the aws-vault profile name Flag
	VaultAWSProfileFlag string = "aws-profile"
	// VaultAWSVaultFlag is the aws-vault flag
	VaultAWSVaultFlag string = "aws-vault"
	// VaultAWSSessionTokenFlag is the AWS session token flag
	VaultAWSSessionTokenFlag string = "aws-session-token"
	// VaultAWSSessionDurationFlag is the AWS session duration flag
	VaultAWSSessionDurationFlag string = "aws-session-duration"
	// VaultAWSAssumeRoleTTLFlag is the AWS assume role TTL flag
	VaultAWSAssumeRoleTTLFlag string = "aws-assume-role-ttl"

	// VaultAWSKeychainNameDefault is the aws-vault default keychain name
	VaultAWSKeychainNameDefault string = "login"
)
View Source
const (
	// InterfaceFlag is the Interface Flag
	InterfaceFlag string = "interface"

	// GracefulShutdownTimeoutFlag is the Graceful Shutdown Timeout Flag
	GracefulShutdownTimeoutFlag string = "graceful-shutdown-timeout"

	// DefaultGracefulShutdownDuration The default graceful shutdown duration
	DefaultGracefulShutdownDuration = time.Second * 25

	// MinimumGracefulShutdownDuration The minimum graceful shutdown duration
	MinimumGracefulShutdownDuration = time.Second * 5
)
View Source
const (
	// AWSRegionFlag is the generic AWS Region Flag
	AWSRegionFlag string = "aws-region"
)
View Source
const (
	// CSRFAuthKeyFlag is the CSRF Auth Key Flag
	CSRFAuthKeyFlag string = "csrf-auth-key"
)
View Source
const (
	//DebugPProfFlag enables the pprof debugging endpoints
	DebugPProfFlag string = "debug-pprof"
)
View Source
const (
	// DevlocalAuthFlag is the Devlocal Auth Flag
	DevlocalAuthFlag string = "devlocal-auth"
)
View Source
const (
	// FeatureFlagAccessCode determines whether or not service members are prompted for an access code before they start onboarding
	FeatureFlagAccessCode string = "feature-flag-access-code"
)
View Source
const (
	// MigrationGenPathFlag is the migration path flag used for generating new migrations
	MigrationGenPathFlag string = "migration-gen-path"
)
View Source
const (
	// MigrationPathFlag is the migration path flag used for finding files to migrate the DB
	MigrationPathFlag string = "migration-path"
)

Variables

This section is empty.

Functions

func CACStoreLogin

func CACStoreLogin(v *viper.Viper, store *pksigner.Store) (*pksigner.Store, error)

CACStoreLogin login to existing CAC store Call 'defer store.Close()' after retrieving the store

func CheckAWSRegion

func CheckAWSRegion(v *viper.Viper) (string, error)

CheckAWSRegion validates the AWS Region command line flags

func CheckAWSRegionForService

func CheckAWSRegionForService(region, awsServiceName string) error

CheckAWSRegionForService validates AWS command line flags against a region

func CheckAuth

func CheckAuth(v *viper.Viper) error

CheckAuth validates Auth command line flags

func CheckBuild

func CheckBuild(v *viper.Viper) error

CheckBuild validates the build command line flags

func CheckCAC

func CheckCAC(v *viper.Viper) error

CheckCAC validates CAC command line flags

func CheckCSRF

func CheckCSRF(v *viper.Viper) error

CheckCSRF validates CSRF command line flags

func CheckCert

func CheckCert(v *viper.Viper) error

CheckCert validates Cert command line flags

func CheckDPS

func CheckDPS(v *viper.Viper) error

CheckDPS validates DPS command line flags

func CheckDatabase

func CheckDatabase(v *viper.Viper, logger *zap.Logger) error

CheckDatabase validates DB command line flags

func CheckDatabaseRetry

func CheckDatabaseRetry(v *viper.Viper) error

CheckDatabaseRetry validates Database Retry command line flags

func CheckDebugFlags

func CheckDebugFlags(v *viper.Viper) error

CheckDebugFlags validates command line flags

func CheckDevlocal

func CheckDevlocal(v *viper.Viper) error

CheckDevlocal validates the Devlocal command line flags

func CheckEIA

func CheckEIA(v *viper.Viper) error

CheckEIA validates EIA command line flags

func CheckEmail

func CheckEmail(v *viper.Viper) error

CheckEmail validates Email command line flags

func CheckEntrustCert

func CheckEntrustCert(v *viper.Viper) error

CheckEntrustCert validates Cert command line flags

func CheckEnvironment

func CheckEnvironment(v *viper.Viper) error

CheckEnvironment validates the Environment command line flags

func CheckFeatureFlag

func CheckFeatureFlag(v *viper.Viper) error

CheckFeatureFlag validates Verbose command line flags

func CheckGEX

func CheckGEX(v *viper.Viper) error

CheckGEX validates GEX command line flags

func CheckGEXSFTP

func CheckGEXSFTP(v *viper.Viper) error

CheckGEXSFTP validates GEX SFTP command line flags

func CheckHosts

func CheckHosts(v *viper.Viper) error

CheckHosts validates the Hosts command line flags

func CheckIWS

func CheckIWS(v *viper.Viper) error

CheckIWS validates IWS command line flags

func CheckListeners

func CheckListeners(v *viper.Viper) error

CheckListeners validates the Listener command line flags

func CheckLogging

func CheckLogging(v *viper.Viper) error

CheckLogging validates logging command line flags

func CheckMiddleWare

func CheckMiddleWare(v *viper.Viper) error

CheckMiddleWare validates middleware command line flags

func CheckMigration

func CheckMigration(v *viper.Viper) error

CheckMigration validates migration command line flags

func CheckMigrationFile

func CheckMigrationFile(v *viper.Viper) error

CheckMigrationFile validates migration command line flags

func CheckMigrationGenPath

func CheckMigrationGenPath(v *viper.Viper) error

CheckMigrationGenPath validates migration command line flags

func CheckMigrationPath

func CheckMigrationPath(v *viper.Viper) error

CheckMigrationPath validates migration command line flags

func CheckOutboundIP

func CheckOutboundIP(appCtx appcontext.AppContext)

CheckOutboundIP checks outbound IP for logging purposes

func CheckPorts

func CheckPorts(v *viper.Viper) error

CheckPorts validates the Port command line flags

func CheckRedis

func CheckRedis(v *viper.Viper) error

CheckRedis validates Redis command line flags

func CheckRoute

func CheckRoute(v *viper.Viper) error

CheckRoute validates Route command line flags

func CheckServices

func CheckServices(v *viper.Viper) error

CheckServices validates these lovely service flags

func CheckSession

func CheckSession(v *viper.Viper) error

CheckSession validates session command line flags

func CheckStorage

func CheckStorage(v *viper.Viper) error

CheckStorage validates Storage command line flags

func CheckSwagger

func CheckSwagger(v *viper.Viper) error

CheckSwagger validates Swagger command line flags

func CheckTelemetry

func CheckTelemetry(v *viper.Viper) (*telemetry.Config, error)

CheckTelemetry validates the telemetry config

func CheckVault

func CheckVault(v *viper.Viper) error

CheckVault validates Vault command line flags

func CheckWebserver

func CheckWebserver(v *viper.Viper) error

CheckWebserver validates the webserver command line flags

func GetAWSConfig

func GetAWSConfig(v *viper.Viper, verbose bool) (*aws.Config, error)

GetAWSConfig returns an AWS Config struct using aws-vault credentials for use in an AWS session

func GetAWSCredentialsFromKeyring

func GetAWSCredentialsFromKeyring(keychainName string, awsProfile string, sessionDuration time.Duration, assumeRoleTTL time.Duration) (*credentials.Credentials, error)

GetAWSCredentialsFromKeyring uses aws-vault to return AWS credentials from a system keyring.

func GetCACStore

func GetCACStore(v *viper.Viper) (*pksigner.Store, error)

GetCACStore retrieves the CAC store Call 'defer store.Close()' after retrieving the store

func InitAWSFlags

func InitAWSFlags(flag *pflag.FlagSet)

InitAWSFlags initializes AWS command line flags

func InitAuthFlags

func InitAuthFlags(flag *pflag.FlagSet)

InitAuthFlags initializes Auth command line flags

func InitBuildFlags

func InitBuildFlags(flag *pflag.FlagSet)

InitBuildFlags initializes the build command line flags

func InitCACFlags

func InitCACFlags(flag *pflag.FlagSet)

InitCACFlags initializes the CAC Flags

func InitCSRFFlags

func InitCSRFFlags(flag *pflag.FlagSet)

InitCSRFFlags initializes CSRF command line flags

func InitCertFlags

func InitCertFlags(flag *pflag.FlagSet)

InitCertFlags initializes the Certificate Flags

func InitDPSFlags

func InitDPSFlags(flag *pflag.FlagSet)

InitDPSFlags initializes the DPS command line flags

func InitDatabase

func InitDatabase(v *viper.Viper, creds *credentials.Credentials, logger *zap.Logger) (*pop.Connection, error)

InitDatabase initializes a Pop connection from command line flags. v is the viper Configuration. creds must relate to an assumed role and can't point to a user or task role directly. logger is the application logger.

func InitDatabaseFlags

func InitDatabaseFlags(flag *pflag.FlagSet)

InitDatabaseFlags initializes DB command line flags

func InitDatabaseRetryFlags

func InitDatabaseRetryFlags(flag *pflag.FlagSet)

InitDatabaseRetryFlags initializes Database Retry command line flags

func InitDebugFlags

func InitDebugFlags(flag *pflag.FlagSet)

InitDebugFlags initializes the Debug command line flags

func InitDevlocalFlags

func InitDevlocalFlags(flag *pflag.FlagSet)

InitDevlocalFlags initializes the Devlocal command line flags

func InitEIAFlags

func InitEIAFlags(flag *pflag.FlagSet)

InitEIAFlags initializes EIA command line flags

func InitEmailFlags

func InitEmailFlags(flag *pflag.FlagSet)

InitEmailFlags initializes Email command line flags

func InitEntrustCertFlags

func InitEntrustCertFlags(flag *pflag.FlagSet)

InitEntrustCertFlags initializes the Certificate Flags

func InitEnvironmentFlags

func InitEnvironmentFlags(flag *pflag.FlagSet)

InitEnvironmentFlags initializes the Environment command line flags

func InitFeatureFlags

func InitFeatureFlags(flag *pflag.FlagSet)

InitFeatureFlags initializes FeatureFlags command line flags

func InitGEXFlags

func InitGEXFlags(flag *pflag.FlagSet)

InitGEXFlags initializes GEX command line flags

func InitGEXSFTP

func InitGEXSFTP(appCtx appcontext.AppContext, sshClient *ssh.Client) (*sftp.Client, error)

InitGEXSFTP initializes a GEX SFTP client from command line flags.

func InitGEXSFTPFlags

func InitGEXSFTPFlags(flag *pflag.FlagSet)

InitGEXSFTPFlags initializes GEX SFTP command line flags

func InitGEXSSH

func InitGEXSSH(appCtx appcontext.AppContext, v *viper.Viper) (*ssh.Client, error)

InitGEXSSH initializes a GEX SSH client from command line flags.

func InitHostFlags

func InitHostFlags(flag *pflag.FlagSet)

InitHostFlags initializes the Hosts command line flags

func InitIWSFlags

func InitIWSFlags(flag *pflag.FlagSet)

InitIWSFlags initializes CSRF command line flags

func InitListenerFlags

func InitListenerFlags(flag *pflag.FlagSet)

InitListenerFlags initializes Listener command line flags

func InitLoggingFlags

func InitLoggingFlags(flag *pflag.FlagSet)

InitLoggingFlags initializes the logging command line flags

func InitMiddlewareFlags

func InitMiddlewareFlags(flag *pflag.FlagSet)

InitMiddlewareFlags initializes the Middleware command line flags

func InitMigrationFileFlags

func InitMigrationFileFlags(flag *pflag.FlagSet)

InitMigrationFileFlags initializes the Migration command line flags

func InitMigrationFlags

func InitMigrationFlags(flag *pflag.FlagSet)

InitMigrationFlags initializes the Migration command line flags

func InitMigrationGenPathFlags

func InitMigrationGenPathFlags(flag *pflag.FlagSet)

InitMigrationGenPathFlags initializes the Migration command line flags

func InitMigrationPathFlags

func InitMigrationPathFlags(flag *pflag.FlagSet)

InitMigrationPathFlags initializes the Migration command line flags

func InitPortFlags

func InitPortFlags(flag *pflag.FlagSet)

InitPortFlags initializes Port command line flags

func InitRedis

func InitRedis(appCtx appcontext.AppContext, v *viper.Viper) (*redis.Pool, error)

InitRedis initializes a Redis pool from command line flags. v is the viper Configuration. logger is the application logger.

func InitRedisFlags

func InitRedisFlags(flag *pflag.FlagSet)

InitRedisFlags initializes RedisFlags command line flags

func InitRouteFlags

func InitRouteFlags(flag *pflag.FlagSet)

InitRouteFlags initializes Route command line flags

func InitServiceFlags

func InitServiceFlags(flag *pflag.FlagSet)

InitServiceFlags initializes the service command line flags

func InitSessionFlags

func InitSessionFlags(flag *pflag.FlagSet)

InitSessionFlags initializes SessionFlags command line flags

func InitStorageFlags

func InitStorageFlags(flag *pflag.FlagSet)

InitStorageFlags initializes Storage command line flags

func InitSwaggerFlags

func InitSwaggerFlags(flag *pflag.FlagSet)

InitSwaggerFlags initializes the Swagger command line flags

func InitTelemetryFlags

func InitTelemetryFlags(flag *pflag.FlagSet)

InitTelemetryFlags initializes the open telemetry flags

func InitVaultFlags

func InitVaultFlags(flag *pflag.FlagSet)

InitVaultFlags initializes Vault command line flags

func InitWebserverFlags

func InitWebserverFlags(flag *pflag.FlagSet)

InitWebserverFlags initializes the webserver command line flags

func LogLevelIsDebug

func LogLevelIsDebug(v *viper.Viper) bool

LogLevelIsDebug is a helper for functions that require a boolean to determine log verbosity

func ParseCertificates

func ParseCertificates(str string) []string

ParseCertificates takes a certificate and parses it into an slice of individual certificates

func ParsePrivateKey

func ParsePrivateKey(str string) []string

ParsePrivateKey takes a private key and parses it into an slice of individual keys

func ValidateClientID

func ValidateClientID(v *viper.Viper, flagname string) error

ValidateClientID validates a proper Login.gov ClientID was passed

func ValidateHost

func ValidateHost(v *viper.Viper, flagname string) error

ValidateHost validates a Hostname passed in from the command line

func ValidatePort

func ValidatePort(v *viper.Viper, flagname string) error

ValidatePort validates a Port passed in from the command line

func ValidateProtocol

func ValidateProtocol(v *viper.Viper, flagname string) error

ValidateProtocol validates a Protocol passed in from the command line

func ValidateSessionLifetime

func ValidateSessionLifetime(v *viper.Viper, flagname string) error

ValidateSessionLifetime validates session lifetime

func ValidateSessionTimeout

func ValidateSessionTimeout(v *viper.Viper, flagname string) error

ValidateSessionTimeout validates session idle timeout

func ValidateStacktraceLength

func ValidateStacktraceLength(v *viper.Viper, flagname string) error

ValidateStacktraceLength validates STACKTRACE_LENGTH is an integer between 1 and 50

func ValidateURL

func ValidateURL(v *viper.Viper, flagname string) error

ValidateURL validates a URL passed in from the command line

Types

type ErrInvalidLabel

type ErrInvalidLabel struct {
	Cert string
	Key  string
}

ErrInvalidLabel is an invalid label error

func (*ErrInvalidLabel) Error

func (e *ErrInvalidLabel) Error() string

Error is an error return

type ErrInvalidPKCS7

type ErrInvalidPKCS7 struct {
	Path string
}

ErrInvalidPKCS7 is an Invalid PKCS7 error

func (*ErrInvalidPKCS7) Error

func (e *ErrInvalidPKCS7) Error() string

Error is the error method

type ErrInvalidPath

type ErrInvalidPath struct {
	Path string
}

ErrInvalidPath is an invalid path error

func (*ErrInvalidPath) Error

func (e *ErrInvalidPath) Error() string

Error is an error return

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL