package
2.85.0+incompatible
Repository: https://github.com/transcom/mymove.git
Documentation: pkg.go.dev

# Functions

CACStoreLogin login to existing CAC store Call 'defer store.Close()' after retrieving the store.
CheckAuth validates Auth command line flags.
CheckAWSRegion validates the AWS Region command line flags.
CheckBuild validates the build command line flags.
CheckCAC validates CAC command line flags.
CheckCert validates Cert command line flags.
CheckCSRF validates CSRF command line flags.
CheckDatabase validates DB command line flags.
CheckDatabaseRetry validates Database Retry command line flags.
CheckDebugFlags validates command line flags.
CheckDevlocal validates the Devlocal command line flags.
CheckEIA validates EIA command line flags.
CheckEmail validates Email command line flags.
CheckEntrustCert validates Cert command line flags.
CheckEnvironment validates the Environment command line flags.
CheckFeatureFlag validates the URL.
CheckGEX validates GEX command line flags.
CheckGEXSFTP validates GEX SFTP command line flags.
CheckHosts validates the Hosts command line flags.
CheckIWS validates IWS command line flags.
CheckListeners validates the Listener command line flags.
CheckLogging validates logging command line flags.
No description provided by the author
CheckMiddleWare validates middleware command line flags.
CheckMigration validates migration command line flags.
CheckMigrationFile validates migration command line flags.
CheckMigrationGenPath validates migration command line flags.
CheckMigrationPath validates migration command line flags.
CheckOutboundIP checks outbound IP for logging purposes.
CheckPorts validates the Port command line flags.
CheckReceiver validates Storage command line flags.
CheckRedis validates Redis command line flags.
CheckRoute validates Route command line flags.
CheckServices validates these lovely service flags.
CheckSession validates session command line flags.
CheckStorage validates Storage command line flags.
CheckSwagger validates Swagger command line flags.
CheckTelemetry validates the telemetry config.
CheckTPPSFlags validates the TPPS processing command line flags.
CheckWebserver validates the webserver command line flags.
GetCACStore retrieves the CAC store Call 'defer store.Close()' after retrieving the store.
No description provided by the author
InitAuthFlags initializes Auth command line flags.
InitAWSFlags initializes AWS command line flags.
InitBuildFlags initializes the build command line flags.
InitCACFlags initializes the CAC Flags.
InitCertFlags initializes the Certificate Flags.
InitCSRFFlags initializes CSRF command line flags.
InitDatabase initializes a Pop connection from command line flags.
InitDatabaseFlags initializes DB command line flags.
InitDatabaseRetryFlags initializes Database Retry command line flags.
InitDebugFlags initializes the Debug command line flags.
InitDevlocalFlags initializes the Devlocal command line flags.
InitEIAFlags initializes EIA command line flags.
InitEmailFlags initializes Email command line flags.
InitEntrustCertFlags initializes the Certificate Flags.
InitEnvironmentFlags initializes the Environment command line flags.
InitFeatureFlags.
InitGEXFlags initializes GEX command line flags.
InitGEXSFTP initializes a GEX SFTP client from command line flags.
InitGEXSFTPFlags initializes GEX SFTP command line flags.
InitGEXSSH initializes a GEX SSH client from command line flags.
InitHostFlags initializes the Hosts command line flags.
InitIWSFlags initializes CSRF command line flags.
InitListenerFlags initializes Listener command line flags.
InitLoggingFlags initializes the logging command line flags.
No description provided by the author
InitMiddlewareFlags initializes the Middleware command line flags.
InitMigrationFileFlags initializes the Migration command line flags.
InitMigrationFlags initializes the Migration command line flags.
InitMigrationGenPathFlags initializes the Migration command line flags.
InitMigrationPathFlags initializes the Migration command line flags.
InitPortFlags initializes Port command line flags.
InitReceiverFlags initializes Storage command line flags.
InitRedis initializes a Redis pool from command line flags.
InitRedisFlags initializes RedisFlags command line flags.
InitRouteFlags initializes Route command line flags.
InitServiceFlags initializes the service command line flags.
InitSessionFlags initializes SessionFlags command line flags.
InitStorageFlags initializes Storage command line flags.
InitSwaggerFlags initializes the Swagger command line flags.
InitTelemetryFlags initializes the open telemetry flags.
InitTPPSFlags initializes TPPS SFTP command line flags.
InitWebserverFlags initializes the webserver command line flags.
LogLevelIsDebug is a helper for functions that require a boolean to determine log verbosity.
ParseCertificates takes a certificate and parses it into an slice of individual certificates.
ParsePrivateKey takes a private key and parses it into an slice of individual keys.
PingPopConnection pings the database and returns an error if it is not reachable.
ValidateHost validates a Hostname passed in from the command line.
ValidatePort validates a Port passed in from the command line.
ValidateProtocol validates a Protocol passed in from the command line.
ValidateSessionLifetime validates session lifetime.
ValidateSessionTimeout validates session idle timeout.
ValidateStacktraceLength validates STACKTRACE_LENGTH is an integer between 1 and 50.
ValidateURL validates a URL passed in from the command line.

# Constants

AdminSwaggerFlag is the Admin Swagger Flag.
AWSRegionFlag is the generic AWS Region Flag.
aws-sdk-go-v2 does not expose a constant for the regions anymore.
AWSS3BucketNameFlag is the AWS S3 Bucket Name Flag.
AWSS3KeyNamespaceFlag is the AWS S3 Key Namespace Flag.
AWSS3RegionFlag is the AWS S3 Region Flag.
AWSSESDomainFlag is the AWS SES Domain Flag.
AWSSESRegionFlag is the AWS SES Region Flag.
BuildRootFlag is the build root flag.
CACFlag indicates that a CAC should be used.
CertLabelFlag is the Certificate Label to use with the smart card.
RA Summary: gosec - G101 - Password Management: Hardcoded PasswordRA: This line was flagged because of use of the word "secret"RA: This line is used to identify the name of the flag.
CSRFAuthKeyFlag is the CSRF Auth Key Flag.
DbConnMaxIdleTimeDefault is how long a connection remains idle before being closed.
DbConnMaxIdleFlag configures the maximum connection idle time in seconds.
DbConnMaxLifetimeDefault is how long a connection should be left open to the database.
DbConnMaxLifetimeFlag configures the maximum connection lifetime in seconds.
DbDebugFlag is the DB Debug flag.
DbEnvContainer is the Container DB Env name.
DbEnvDevelopment is the Development DB Env name.
DbEnvFlag is the DB environment flag.
DbEnvTest is the Test DB Env name.
DbHostFlag is the DB host flag.
DbIamFlag is the DB IAM flag.
DbIamRoleFlag is the DB IAM Role flag.
DbIdlePoolDefault is the default db idle pool connections.
DbIdlePoolFlag is the DB idle pool flag.
DbUseInstrumentedDriverFlag indicates if additional db instrumentation should be done.
DbNameFlag is the DB name flag.
DbNameTest The name of the test database.
DbPasswordFlag is the DB password flag.
DbPoolDefault is the default db pool connections.
DbPoolFlag is the DB pool flag.
DbPoolMax is the upper limit the db pool can use for connections which constrains the user input.
DbPortFlag is the DB port flag.
DbRegionFlag is the DB Region flag.
DbRetryIntervalFlag is the DB retry interval flag.
DbRetryMaxFlag is the DB retry maximum flag.
DbSSLModeFlag is the DB SSL Mode flag.
DbSSLRootCertFlag is the DB SSL Root Cert flag.
DbUserFlag is the DB user flag.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DebugPProfFlag enables the pprof debugging endpoints.
DefaultBuildRoot Path to the build directory.
DefaultGracefulShutdownDuration The default graceful shutdown duration.
DevlocalAuthFlag is the Devlocal Auth Flag.
DevlocalCAFlag is the Devlocal CA Flag.
No description provided by the author
DoDCAPackageFlag is the DoD CA Package Flag.
DTODApiPasswordFlag is the DTOD API Password Flag.
DTODApiURLFlag is the DTOD API URL Flag.
DTODApiUsernameFlag is the DTOD API Username Flag.
DTODApiWSDLFlag is the DTOD API WSDL Flag.
DTODSimulateOutage is the DTOD Use Mock Flag.
DTODUseMockFlag is the DTOD Use Mock Flag.
EIAKeyFlag is the EIA Key Flag.
EIAURLFlag is the EIA URL Flag.
EmailBackendFlag is the Email Backend Flag.
EntrustG2CertFlag is the Entrust G2 Cert Flag.
EntrustL1KCertFlag is the Entrust L1K Cert Flag.
EnvironmentDemo is the GovCloud demo Environment name.
EnvironmentDevelopment is the Development Environment name.
EnvironmentExp is the GovCloud exp Environment name.
EnvironmentExperimental is the Experimental Environment name.
EnvironmentFlag is the Environment Flag.
EnvironmentLoadtest is the GovCloud loadtest Environment name.
EnvironmentPrd is the GovCloud prd Environment name.
EnvironmentReview is a reviewapp.
EnvironmentStg is the GovCloud stg Environment name.
EnvironmentTest is the Test Environment name.
FeatureFlagAPITokenFlag is the api token.
FeatureFlagDODIDValidation.
FeatureFlagServerURLFlag is the URL to the feature flag server.
RA Summary: gosec - G101 - Password Management: Hardcoded PasswordRA: This line was flagged because of use of the word "password"RA: This line is used to identify the name of the flag.
GEXBasicAuthUsernameFlag is the GEX Basic Auth Username Flag.
GEXXPrivateKeyFlag is the ENV var for the private key which is used in establishing an ssh connection to the GEX server.
GEXSendProdInvoiceFlag is the GEX Send Prod Invoice Flag.
GEXSFTP824PickupDirectory is the ENV var for the directory where GEX delivers responses.
GEXSFTP997PickupDirectory is the ENV var for the directory where GEX delivers responses.
GEXSFTPHostKeyFlag is the ENV var for the GEX SFTP host key.
GEXSFTPIPAddressFlag is the ENV var for the GEX SFTP IP address.
RA Summary: gosec - G101 - Password Management: Hardcoded PasswordRA: This line was flagged because of use of the word "password"RA: This line is used to identify the name of the flag.
GEXSFTPPortFlag is the ENV var for the GEX SFTP port.
GEXSFTPUserIDFlag is the ENV var for the GEX SFTP user ID.
GEXURLFlag is the GEX URL FLag.
GHCSwaggerFlag is the GHC Swagger Flag.
GracefulShutdownTimeoutFlag is the Graceful Shutdown Timeout Flag.
HealthListenerFlag is whether a special listener for health checks should be enabled.
HealthPort is the default port for the health listener.
HealthPortFlag is the port that the health listener uses.
HEREMapsAppCodeFlag is the HERE Maps App Code Flag.
HEREMapsAppIDFlag is the HERE Maps App ID Flag.
HEREMapsGeocodeEndpointFlag is the HERE Maps Geocode Endpoint Flag.
HEREMapsRoutingEndpointFlag is the HERE Maps Routing Endpoint Flag.
HTTPAdminServerNameFlag is the HTTP Admin Server Name Flag.
HTTPAdminServerNameLocal is the HTTP Admin Server Name for Local.
HTTPMyServerNameFlag is the HTTP My Server Name Flag.
HTTPMyServerNameLocal is the HTTP My Server Name for Local.
HTTPOfficeServerNameFlag is the HTTP Office Server Name Flag.
HTTPOfficeServerNameLocal is the HTTP Office Server Name for Local.
HTTPOrdersServerNameFlag is the HTTP Orders Server Name Flag.
HTTPOrdersServerNameLocal is the HTTP Orders Server Name for Local.
HTTPPPTASServerNameFlag is the HTTP PPTAS Prime Server Name Flag.
HTTPPrimeServerNameFlag is the HTTP GHC Prime Server Name Flag.
HTTPPrimeServerNameLocal is the HTTP GHC Prime Server Name for Local.
InterfaceFlag is the Interface Flag.
InternalSwaggerFlag is the Internal Swagger Flag.
IWSRBSEnabledFlag is the IWS RBS Enabled Flag.
IWSRBSHostFlag is the IWS RBS Host Flag.
KeyLabelFlag is the Key Label to use with the smart card.
LocalStorageRootFlag is the Local Storage Root Flag.
LocalStorageWebRootFlag is the Local Storage WebRoot Flag.
LoggingEnvDevelopment is the development logging environment.
LoggingEnvFlag is the logging environment flag.
LoggingEnvProduction is the production logging environment.
LoggingLevelDebug is the debug logging level.
LoggingLevelError is the error logging level.
LoggingLevelFatal is the fatal logging level.
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.
LoggingLevelInfo is the info logging level.
LoggingLevelWarn is the warn logging level.
LogTaskMetadataFlag is the Log Task Metadata Flag.
Maintenance Flag.
MaxBodySizeDefault is 20 mb.
MaxBodySizeFlag is the maximum body size for requests.
MigrationGenPathFlag is the migration path flag used for generating new migrations.
deprecated.
MigrationNameFlag is the migration name flag.
MigrationPathFlag is the migration path flag used for finding files to migrate the DB.
MigrationTypeFlag is the migration manifest flag.
MigrationVersionFlag is the migration version flag.
MigrationWaitFlag is the migration wait flag.
MinimumGracefulShutdownDuration The minimum graceful shutdown duration.
MoveMilDoDCACertFlag is the Move.mil DoD CA Cert Flag.
MoveMilDoDTLSCertFlag is the Move.mil DoD TLS Cert Flag.
MoveMilDoDTLSKeyFlag is the Move.mil DoD TLS Key Flag.
MutualTLSListenerFlag is the Mutual TLS Listener Flag.
MutualTLSPort is the default port for mTLS traffic.
MutualTLSPortFlag is the Mutual TLS Port Flag.
NoTLSListenerFlag is the No TLS Listener Flag.
NoTLSPort is the default port in develompent for HTTP traffic.
NoTLSPortFlag is the No TLS Port Flag.
Set of flags used for authentication.
Okta Admin client id and secret flags.
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.
Okta API key flagRA Summary: gosec - G101 - Password Management: Hardcoded PasswordRA: This line was flagged because of use of the word "key"RA: This line is used to identify the name of the flag.
Set of flags used for authentication.
Okta Customer client id and secret flags.
Set of flags used for authentication.
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.
Set of flags used for authentication.
Okta Office client id and secret flags.
Set of flags used for authentication.
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.
OktaTenantCallbackPortFlag is the test-milmove Callback Port Flag.
OktaTenantCallbackPortFlag is the test-milmove Callback Protocol Flag.
Okta flags for local development environment that serves test-milmove.okta.mil Okta tenant flags.
OrdersSwaggerFlag is the Orders Swagger Flag.
PKCS11ModuleFlag is the location of the PCKS11 module to use with the smart card.
PPTASSwaggerFlag is the PPTAS Swagger Flag.
PrimeSwaggerFlag is the Prime Swagger Flag.
PrimeV2SwaggerFlag is the Prime V2 Swagger Flag.
PrimeV3SwaggerFlag is the Prime V3 Swagger Flag.
ProcessTPPSCustomDateFile is the env var for the date of a file that can be customized if we want to process a payment file other than the daily run of the task.
ReceiverBackendFlag is the Receiver Backend Flag.
ReceiverCleanupOnStartFlag is the Receiver Cleanup On Start Flag.
RedisConnectTimeoutFlag specifies how long to wait to establish a connection to the Redis instance.
RedisDBNameFlag is the ENV var for the Redis database name, which is represented by a positive integer.
RedisEnabledFlag specifies whether or not we attempt to connect to Redis.
RedisHostFlag is the ENV var for the Redis hostname.
RedisIdleTimeoutFlag Closes connections after this duration.
RedisMaxIdleFlag specifies the maximum number of idle connections in the pool.
RedisPasswordFlag is the ENV var for the Redis password.
RedisPortFlag is the ENV var for the Redis port.
RedisSSLEnabledFlag specifies if SSL mode is enabled for connections.
ReviewBaseDomainDefault is the default base domain for review apps.
ReviewBaseDomainFlag is the base domain name for review apps.
SendToSyncada is the flag to control if we try sending files to syncada or not.
ServeAdminFlag is the admin service flag.
ServeAPIInternalFlag is the internal api service flag.
ServeClientCollectorFlag enables the endpoints to collect client telemetry and logs.
ServeGHCFlag is the ghc api service flag.
ServeOrdersFlag is the orders service flag.
ServePPTASFlag is the PPTAS api service flag.
ServePrimeFlag is the prime api flag.
ServePrimeSimulatorFlag is the prime simulator api flag.
ServeSupportFlag is the support api flag.
ServeSwaggerUIFlag is the Serve Swagger UI Flag.
SessionIdleTimeoutInMinutesFlag sets the session's Idle Timeout in minutes.
SessionLifetimeInHoursFlag sets the session's absolute expiry in hours.
SNSAccountId is the application's AWS account id.
SNSRegionFlag is the SNS Region flag.
SNSTagsUpdatedTopicFlag is the SNS Tags Updated Topic Flag.
SSLModeAllow is the allow SSL Mode.
SSLModeDisable is the disable SSL Mode.
SSLModePrefer is the prefer SSL Mode.
SSLModeRequire is the require SSL Mode.
SSLModeVerifyCA is the verify-ca SSL Mode.
SSLModeVerifyFull is the verify-full SSL Mode.
StacktraceLengthFlag is the flag that defines the number of lines to print in a stack trace Example: export STACKTRACE_LENGTH=10.
StorageBackendFlag is the Storage Backend Flag.
SupportSwaggerFlag is the Support Swagger Flag.
SwaggerFlag is the Public Swagger Flag.
SysAdminEmail is flag for the System Administrators' email.
TelemetryCollectSecondsFlag configures the metric collection period in seconds.
TelemetryEnabledFlag is the Trace Enable Flag.
TelemetryEndpointFlag configures the endpoint used for open telemetry tracing.
TelemetryReadEventsEnabledFlag enables read events.
TelemetrySamplingFractionFlag configures the percent of traces to sample.
TelemetryUseXrayIDFlag enables using AWS Xray Trace IDs for open telemetry.
TelemetryWriteEventsEnabledFlag enables write events.
TLSListenerFlag is the TLS Listener Flag.
TLSPort is the default port for TLS traffic.
TLSPortFlag is the TLS Port Flag.
TokenLabelFlag is the Token Label to use with the smart card.
TPPSS3Bucket is the env var for the S3 bucket for TPPS payment files that we import from US bank.
TPPSS3Folder is the env var for the S3 folder inside the tpps_s3_bucket for TPPS payment files that we import from US bank.
VersionTimeFormat is the Go time format for creating a version number.

# Structs

ErrInvalidLabel is an invalid label error.
ErrInvalidPath is an invalid path error.
ErrInvalidPKCS7 is an Invalid PKCS7 error.
No description provided by the author