github.com/vchain-us/vcn@v0.9.11-0.20210921212052-a2484d23c0b3/pkg/meta/constants.go

/*
 * Copyright (c) 2018-2020 vChain, Inc. All Rights Reserved.
 * This software is released under GPL3.
 * The full license information can be found under:
 * https://www.gnu.org/licenses/gpl-3.0.en.html
 *
 */

package meta

import (
	"fmt"
	"log"
	"runtime"

	"github.com/fatih/color"
)

// Level is the type for all possible signature levels
type Level int64

// Status is the type for all possible asset statuses
type Status int64

// Visibility is the type for all visibility values
type Visibility int64

// Allowed Level values
const (
	LevelDisabled         Level = -1
	LevelUnknown          Level = 0
	LevelEmailVerified    Level = 1
	LevelSocialVerified   Level = 2
	LevelIDVerified       Level = 3
	LevelLocationVerified Level = 4
	LevelCNLC             Level = 98
	LevelVchain           Level = 99
)

// Allowed Status values
const (
	StatusTrusted       Status = 0
	StatusUntrusted     Status = 1
	StatusUnknown       Status = 2
	StatusUnsupported   Status = 3
	StatusApikeyRevoked Status = 4
)

// Allowed Visibility values
const (
	VisibilityPublic  Visibility = 0
	VisibilityPrivate Visibility = 1
)

// Event tracking related consts
const (
	VcnLoginEvent       string = "VCN_LOGIN"
	VcnSignEvent        string = "VCN_SIGN"
	VcnVerifyEvent      string = "VCN_VERIFY"
	VcnAlertVerifyEvent string = "VCN_ALERT_VERIFY"
)

// vcn environment variable names
const (
	VcnUserEnv                   string = "VCN_USER"
	VcnPasswordEnv               string = "VCN_PASSWORD"
	VcnNotarizationPassword      string = "VCN_NOTARIZATION_PASSWORD"
	VcnNotarizationPasswordEmpty string = "VCN_NOTARIZATION_PASSWORD_EMPTY"
	VcnOtp                       string = "VCN_OTP"
	VcnOtpEmpty                  string = "VCN_OTP_EMPTY"
	VcnLcApiKey                  string = "VCN_LC_API_KEY"
	VcnLcHost                    string = "VCN_LC_HOST"
	VcnLcPort                    string = "VCN_LC_PORT"
	VcnLcCert                    string = "VCN_LC_CERT"
	VcnLcNoTls                   string = "VCN_LC_NO_TLS"
	VcnLcSkipTlsVerify           string = "VCN_LC_SKIP_TLS_VERIFY"
	VcnSigningPubKeyFile         string = "VCN_SIGNING_PUB_KEY_FILE"
)

const VcnExitCode string = "override default exit codes in case of success"

const VcnPrefix string = "vcn"
const VcnAttachmentLabelPrefix string = "_ITEM.ATTACH.LABEL"

// Ledger compliance
const VcnLCPluginTypeHeaderName string = "lc-plugin-type"
const VcnLCLedgerHeaderName string = "lc-ledger"
const VcnLCVersionHeaderName string = "version"
const VcnLCPluginTypeHeaderValue string = "vcn"
const VcnLCCmdHeaderName = "vcn-command"
const VcnLCNotarizeCmdHeaderValue = "notarize"
const VcnLCVerifyCmdHeaderValue = "verify"

const VcnLcHostFlagDesc string = "if set with host, action will be route to a Codenotary Cloud server"
const VcnLcPortFlagDesc string = "set port for set up a connection to a Codenotary Cloud server (default 443). If --lc-no-tls is provided default port will be 80"
const VcnLcCertPathDesc string = "local or absolute path to a certificate file needed to set up tls connection to a Codenotary Cloud server"
const VcnLcSkipTlsVerifyDesc string = "disables tls certificate verification when connecting to a Codenotary Cloud server"
const VcnLcNoTlsDesc string = "allow insecure connections when connecting to a Codenotary Cloud server"
const VcnLcApiKeyDesc string = "Codenotary Cloud server api key"
const VcnLcLedgerDesc string = "Codenotary Cloud ledger. Required when a multi-ledger API key is used."
const VcnLcAttachDesc string = "add user defined file attachments. Ex. vcn n myfile --attach mysecondfile. (repeat --attach for multiple entries). It's possible to specify a label for each entry, Ex: --attach=vscanner.result:jobid123. In this way it will be possible to retrieve the specific attachment with `vcn a binary1 --attach=vscanner.result:jobid123` or `vcn a binary1 --attach=jobid123` to get all attachments"
const VcnLcCIAttribDesc string = "detect CI environment variables context if presents and inject "
const VcnLcUidDesc string = "authenticate on a specific artifact uid"
const VcnLcAttachmentAuthDesc string = `authenticate an artifact on a specific attachment label. With this it's be possible to retrieve the specific attachment with:
vcn a binary1 --attach=vscanner.result:jobid123 --output=attachments
or to get all attachments for a label:
vcn a binary1 --attach=jobid123 --output=attachments`
const VcnLcForceAttachmentDownloadDesc string = "if provided when downloading attachments files are silently overwritten"
const VcnSigningPubKeyFileNameDesc string = "specify a public key file path to verify signature in messages when connected to a Codenotary Cloud server. If no public key file is specified but server is signig messages is possible an interactive confirmation of the fingerprint. When confirmed the public key is stored in ~/.vcn-trusted-signing-pub-key file."
const VcnSigningPubKeyDesc string = "specify a public key to verify signature in messages when connected to a Codenotary Cloud server. It's required a valid ECDSA key content without header and footer. Ex: --signing-pub-key=\"MFkwE...y5i4w==\""
const VcnEnforceSignatureVerifyDesc string = "if this flag is provided vcn will disable signature auto trusting when connecting to a new Codenotary Cloud server"

const BomEntryKeyName string = "BOM"

// UserAgent returns the vcn's User-Agent string
func UserAgent() string {
	// Syntax reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent#Syntax
	return fmt.Sprintf("vcn/%s (%s; %s)", Version(), runtime.GOOS, runtime.GOARCH)
}

// String returns the name of the given level as string.
func (l Level) String() string {
	switch l {
	case LevelDisabled:
		return "DISABLED"
	case LevelUnknown:
		return "0 - UNKNOWN"
	case LevelEmailVerified:
		return "1 - EMAIL_VERIFIED"
	case LevelSocialVerified:
		return "2 - SOCIAL_VERIFIED"
	case LevelIDVerified:
		return "3 - ID_VERIFIED"
	case LevelLocationVerified:
		return "4 - LOCATION_VERIFIED"
	case LevelVchain:
		return "99 - VCHAIN"
	default:
		log.Fatal("unsupported level: ", int64(l))
		return ""
	}
}

// String returns the name of the given status as string
func (s Status) String() string {
	switch s {
	case StatusTrusted:
		return "TRUSTED"
	case StatusUntrusted:
		return "UNTRUSTED"
	case StatusUnknown:
		return "UNKNOWN"
	case StatusUnsupported:
		return "UNSUPPORTED"
	case StatusApikeyRevoked:
		return "REVOKED"
	default:
		log.Fatal("unsupported status: ", int64(s))
		return ""
	}
}
func (s Status) Int() int {
	return int(s)
}

// StatusNameStyled returns the colorized name of the given status as string
func StatusNameStyled(status Status) string {
	c, s, b := StatusColor(status)
	return color.New(c, s, b).Sprintf(status.String())
}

// String returns the name of the given visibility as string
func (v Visibility) String() string {
	switch v {
	case VisibilityPublic:
		return "PUBLIC"
	case VisibilityPrivate:
		return "PRIVATE"
	default:
		log.Fatal("unsupported visibility: ", int(64))
		return ""
	}
}

// VisibilityForFlag returns VisibilityPublic if public is true, otherwise VisibilityPrivate
func VisibilityForFlag(public bool) Visibility {
	if public {
		return VisibilityPublic
	}
	return VisibilityPrivate
}

const DateShortForm = "2006/1/2-15:04:05"
const IndexDateRangePrefix = "_INDEX.ITEM.INSERTION-DATE."

const VcnDefaultExitCode = 0

const AttachmentSeparator = ".attach."
const VcnSigningPubKeyFileName = ".vcn-trusted-signing-pub-key"