common

package

v1.0.17 Latest Latest Go to latest Published: Jan 28, 2026 License: Apache-2.0, BSD-3-Clause Imports: 7 Imported by: 14

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rdkcentral/xconfwebconfig

Links

Open Source Insights

Documentation ¶

Overview ¶

*

Copyright 2022 Comcast Cable Communications Management, LLC *
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. *
SPDX-License-Identifier: Apache-2.0

*

Copyright 2022 Comcast Cable Communications Management, LLC *
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. *
SPDX-License-Identifier: Apache-2.0

*

Copyright 2021 Comcast Cable Communications Management, LLC *
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. *
SPDX-License-Identifier: Apache-2.0

*

Copyright 2022 Comcast Cable Communications Management, LLC *
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. *
SPDX-License-Identifier: Apache-2.0

*

Copyright 2022 Comcast Cable Communications Management, LLC *
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. *
SPDX-License-Identifier: Apache-2.0

Index ¶

Constants
Variables
func CopyLogFields(src log.Fields) log.Fields
func FieldsGetString(fields log.Fields, keyName string, args ...string) string
func FilterLogFields(src log.Fields, excludes ...string) log.Fields
func GetXconfErrorStatusCode(err error) int
func NewRemoteError(status int, message string) error
func NewRemoteErrorAS(status int, message string) error
func ServerOriginId() string
func UnwrapAll(wrappedErr error) error
func UpdateLogFields(fields, newfields log.Fields)
type Http400Error
- func (e Http400Error) Error() string
type Http404Error
- func (e Http404Error) Error() string
type Http500Error
- func (e Http500Error) Error() string
type InfoVersion
type RemoteHttpError
- func (e RemoteHttpError) Error() string
type RemoteHttpErrorAS
- func (e RemoteHttpErrorAS) Error() string
type ServerConfig
- func NewServerConfig(configFile string) (*ServerConfig, error)
- func NewServerConfigFromText(text string) (*ServerConfig, error)
- func (c *ServerConfig) ConfigBytes() []byte
type Version

Constants ¶

View Source

const (
	LOGGING_TIME_FORMAT        = "2006-01-02 15:04:05.000"
	DATE_TIME_FORMATTER        = "1/2/2006 15:04"
	LAST_CONFIG_LOG_ID         = "0"
	ClientCertExpiryDateFormat = "Jan 2, 2006 @ 15:04:05.000"
)

View Source

const (
	PROP_READONLY_MODE                  = "ReadonlyMode"
	PROP_CANARY_MAXSIZE                 = "CanaryMaxSize"
	PROP_CANARY_DISTRIBUTION_PERCENTAGE = "CanaryDistributionPercentage"
	PROP_CANARY_FW_UPGRADE_STARTTIME    = "CanaryFwUpgradeStartTime"
	PROP_CANARY_FW_UPGRADE_ENDTIME      = "CanaryFwUpgradeEndTime"
	PROP_PRECOOK_LOCKDOWN_ENABLED       = "PrecookLockdownEnabled"
)

View Source

const (
	XCONF_HTTP_HEADER             = "HA-Haproxy-xconf-http"
	XCONF_SNI_HEADER              = "HA-Haproxy-xconf-sni"
	XCONF_HTTP_VALUE              = "xconf-http"
	XCONF_HTTPS_VALUE             = "xconf-https"
	XCONF_MTLS_VALUE              = "xconf-mtls"
	XCONF_MTLS_RECOVERY_VALUE     = "xconf-mtls-recovery"
	HTTP_CLIENT_PROTOCOL          = "http"
	HTTPS_CLIENT_PROTOCOL         = "https"
	MTLS_CLIENT_PROTOCOL          = "mtls"
	MTLS_RECOVERY_CLIENT_PROTOCOL = "mtls-recovery"
	CLIENT_PROTOCOL               = "clientProtocol"
	CLIENT_SNI                    = "clientSni"
	X_FORWARDED_FOR_HEADER        = "X-Forwarded-For"
	HA_FORWARDED_FOR_HEADER       = "HA-Forwarded-For"

	HeaderAuthorization           = "Authorization"
	HeaderUserAgent               = "User-Agent"
	HeaderIfNoneMatch             = "If-None-Match"
	HeaderFirmwareVersion         = "X-System-Firmware-Version"
	HeaderModelName               = "X-System-Model-Name"
	HeaderProfileVersion          = "X-System-Telemetry-Profile-Version"
	HeaderPartnerID               = "X-System-PartnerID"
	HeaderAccountID               = "X-System-AccountID"
	HeaderXconfDataService        = "XconfDataService"
	HeaderTraceparent             = "Traceparent"
	HeaderTracestate              = "Tracestate"
	HeaderMoracide                = "X-Cl-Experiment"
	HeaderCanary                  = "X-Cl-Canary"
	CLIENT_CERT_EXPIRY_HEADER     = "Client-Cert-Expiry"
	XCONF_MTLS_OPTIONAL_VALUE     = "xconf-mtls-optional"
	MTLS_OPTIONAL_CLIENT_PROTOCOL = "mtls-optional"
	CLIENT_CERT_EXPIRY            = "clientCertExpiry"
	CERT_EXPIRY_DAYS              = "certExpiryDays"
	RECOVERY_CERT_EXPIRY          = "recoveryCertExpiry"
)

View Source

const (
	HOST_MAC_PARAM = "hostMac"
	ECM_MAC_PARAM  = "ecmMac"

	ID                         = "id"
	IP_ADDRESS                 = "ipAddress"
	ESTB_IP                    = "estbIP"
	ESTB_MAC_ADDRESS           = "estbMacAddress"
	ESTB_MAC                   = "eStbMac"
	ECM_MAC_ADDRESS            = "ecmMacAddress"
	ECM_MAC                    = "eCMMac"
	ENV                        = "env"
	MODEL                      = "model"
	MODEL_ID                   = "modelId"
	ACCOUNT_MGMT               = "accountMgmt"
	SERIAL_NUM                 = "serialNum"
	PARTNER_ID                 = "partnerId"
	PASSED_PARTNER_ID          = "passedPartnerId"
	FIRMWARE_VERSION           = "firmwareVersion"
	RECEIVER_ID                = "receiverId"
	CONTROLLER_ID              = "controllerId"
	CHANNEL_MAP_ID             = "channelMapId"
	VOD_ID                     = "vodId"
	BYPASS_FILTERS             = "bypassFilters"
	FORCE_FILTERS              = "forceFilters"
	UPLOAD_IMMEDIATELY         = "uploadImmediately"
	TIME_ZONE                  = "timezone"
	TIME_ZONE_OFFSET           = "timeZoneOffset"
	TIME                       = "time"
	APPLICATION_TYPE           = "applicationType"
	ACCOUNT_ID                 = "accountId"
	ACCOUNT_HASH               = "accountHash"
	CONFIG_SET_HASH            = "configSetHash"
	SYNDICATION_PARTNER        = "SyndicationPartner"
	MAC                        = "mac"
	CHECK_NOW                  = "checkNow"
	VERSION                    = "version"
	SETTING_TYPE               = "settingType"
	TABLE_NAME                 = "tableName"
	FIELD                      = "field"
	NAME                       = "name"
	LIST_ID                    = "listId"
	DOWNLOAD_PROTOCOL          = "firmware_download_protocol"
	REBOOT_DECOUPLED           = "rebootDecoupled"
	MATCHED_RULE_TYPE          = "matchedRuleType"
	CAPABILITIES               = "capabilities"
	UPDATED                    = "updated"
	DESCRIPTION                = "description"
	SUPPORTED_MODEL_IDS        = "supportedModelIds"
	FIRMWARE_DOWNLOAD_PROTOCOL = "firmwareDownloadProtocol"
	FIRMWARE_FILENAME          = "firmwareFilename"
	FIRMWARE_LOCATION          = "firmwareLocation"
	IPV6_FIRMWARE_LOCATION     = "ipv6FirmwareLocation"
	UPGRADE_DELAY              = "upgradeDelay"
	REBOOT_IMMEDIATELY         = "rebootImmediately"
	PROPERTIES                 = "properties"
	MANDATORY_UPDATE           = "mandatoryUpdate"
	FIRMWARE_VERSIONS          = "firmwareVersions"
	REGULAR_EXPRESSIONS        = "regularExpressions"
	ADDITIONAL_FW_VER_INFO     = "additionalFwVerInfo"
	EXPERIENCE                 = "experience"
	CERT_EXPIRY_DURATION       = "certExpiryDays"
	SERIAL_NUMBER_PARAM        = "serialNumber"
	COUNTRY_CODE               = "countryCode"
)

View Source

const (
	TR181_DEVICE_TYPE_PARTNER_ID   = "tr181.Device.DeviceInfo.X_RDKCENTRAL-COM_Syndication.PartnerId"
	TR181_DEVICE_TYPE_ACCOUNT_ID   = "tr181.Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID"
	TR181_DEVICE_TYPE_ACCOUNT_HASH = "tr181.Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.MD5AccountHash"
)

View Source

const (
	GenericNamespacedListTypes_STRING      = "STRING"
	GenericNamespacedListTypes_MAC_LIST    = "MAC_LIST"
	GenericNamespacedListTypes_IP_LIST     = "IP_LIST"
	GenericNamespacedListTypes_RI_MAC_LIST = "RI_MAC_LIST"
)

View Source

const (
	NoPenetrationMetricsHeader = "X-No-Penetration-Metrics"
)

Variables ¶

View Source

var (
	CacheUpdateWindowSize int64

	BinaryVersion   = ""
	BinaryBranch    = ""
	BinaryBuildTime = ""

	DefaultIgnoredHeaders = []string{
		"Accept",
		"User-Agent",
		"Authorization",
		"Content-Type",
		"Content-Length",
		"Accept-Encoding",
		"X-B3-Sampled",
		"X-B3-Spanid",
		"X-B3-Traceid",
		"X-Envoy-Decorator-Operation",
		"X-Envoy-External-Address",
		"X-Envoy-Peer-Metadata",
		"X-Envoy-Peer-Metadata-Id",
		"X-Forwarded-Proto",
	}
)

View Source

var (
	NotOK             = fmt.Errorf("!ok")
	NotFound          = fmt.Errorf("Not found")
	NotFirmwareConfig = fmt.Errorf("Not FirmwareCofig")
	NotFirmwareRule   = fmt.Errorf("Not FirmwareRule")
	Forbidden         = fmt.Errorf("Forbidden")
)

View Source

var (
	Http400ErrorType    = &Http400Error{}
	Http404ErrorType    = &Http404Error{}
	Http500ErrorType    = &Http500Error{}
	RemoteHttpErrorType = &RemoteHttpError{}
)

View Source

var AllAppSettings = []string{
	PROP_READONLY_MODE,
	PROP_CANARY_MAXSIZE,
	PROP_CANARY_DISTRIBUTION_PERCENTAGE,
	PROP_CANARY_FW_UPGRADE_STARTTIME,
	PROP_CANARY_FW_UPGRADE_ENDTIME,
	PROP_PRECOOK_LOCKDOWN_ENABLED,
}

View Source

var XconfErrorType = &RemoteHttpErrorAS{}

Functions ¶

func CopyLogFields ¶

func CopyLogFields(src log.Fields) log.Fields

func FieldsGetString ¶

func FieldsGetString(fields log.Fields, keyName string, args ...string) string

func FilterLogFields ¶

func FilterLogFields(src log.Fields, excludes ...string) log.Fields

func GetXconfErrorStatusCode ¶

func GetXconfErrorStatusCode(err error) int

func NewRemoteError ¶

func NewRemoteError(status int, message string) error

func NewRemoteErrorAS ¶

func NewRemoteErrorAS(status int, message string) error

func ServerOriginId ¶ added in v1.0.15

func ServerOriginId() string

func UnwrapAll ¶

func UnwrapAll(wrappedErr error) error

func UpdateLogFields ¶

func UpdateLogFields(fields, newfields log.Fields)

Types ¶

type Http400Error ¶

type Http400Error struct {
	Message string
}

func (Http400Error) Error ¶

func (e Http400Error) Error() string

type Http404Error ¶

type Http404Error struct {
	Message string
}

func (Http404Error) Error ¶

func (e Http404Error) Error() string

type Http500Error ¶

type Http500Error struct {
	Message string
}

func (Http500Error) Error ¶

func (e Http500Error) Error() string

type InfoVersion ¶

type InfoVersion struct {
	ProjectName    string `json:"projectName"`
	ProjectVersion string `json:"projectVersion"`
	ServiceName    string `json:"serviceName"`
	ServiceVersion string `json:"serviceVersion"`
	Source         string `json:"source"`
	Rev            string `json:"rev"`
	GitBranch      string `json:"gitBranch"`
	GitBuildTime   string `json:"gitBuildTime"`
	GitCommitId    string `json:"gitCommitId"`
	GitCommitTime  string `json:"gitCommitTime"`
}

type RemoteHttpError ¶

type RemoteHttpError struct {
	StatusCode int
	Message    string
}

func (RemoteHttpError) Error ¶

func (e RemoteHttpError) Error() string

type RemoteHttpErrorAS ¶

type RemoteHttpErrorAS struct {
	StatusCode int
	Message    string
}

func (RemoteHttpErrorAS) Error ¶

func (e RemoteHttpErrorAS) Error() string

type ServerConfig ¶

type ServerConfig struct {
	*configuration.Config
	// contains filtered or unexported fields
}

func NewServerConfig ¶

func NewServerConfig(configFile string) (*ServerConfig, error)

func NewServerConfigFromText ¶

func NewServerConfigFromText(text string) (*ServerConfig, error)

func (*ServerConfig) ConfigBytes ¶

func (c *ServerConfig) ConfigBytes() []byte

type Version ¶

type Version struct {
	CodeGitCommit   string `json:"code_git_commit"`
	BuildTime       string `json:"build_time"`
	BinaryVersion   string `json:"binary_version"`
	BinaryBranch    string `json:"binary_branch"`
	BinaryBuildTime string `json:"binary_build_time"`
}

Source Files ¶

View all Source files

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