constants.go

// Copyright (c) Edgeless Systems GmbH.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

// constants defines constant values used in the Coordinator.
package constants

import (
	"path/filepath"

	"github.com/edgelesssys/marblerun/util"
)

const (
	// CoordinatorName is the name of the Coordinator.
	// It is used as CN of the root certificate.
	CoordinatorName = "MarbleRun Coordinator"
	// CoordinatorIntermediateName is the name of the Coordinator.
	// It is used as CN of the intermediate certificate which is set when setting or updating a certificate.
	CoordinatorIntermediateName = "MarbleRun Coordinator - Intermediate CA"

	// Storage Keys for the Coordinator's certificates,
	// used to reference the certificates in the store.

	// SKCoordinatorRootCert is the key for the Coordinator's root certificate.
	SKCoordinatorRootCert = "coordinatorRootCert"
	// SKCoordinatorRootKey is the key for private key corresponding to the Coordinator's root certificate.
	SKCoordinatorRootKey = "coordinatorRootKey"
	// SKCoordinatorIntermediateCert is the key for the Coordinator's intermediate certificate.
	SKCoordinatorIntermediateCert = "coordinatorIntermediateCert"
	// SKCoordinatorIntermediateKey is the key for private key corresponding to the Coordinator's root certificate.
	SKCoordinatorIntermediateKey = "coordinatorIntermediateKey"
	// SKMarbleRootCert is the key for the root certificate for Marble certificates.
	SKMarbleRootCert = "marbleRootCert"

	// MeshAddr is the coordinator's address for the gRPC server to listen on.
	MeshAddr = "EDG_COORDINATOR_MESH_ADDR"
	// MeshAddrDefault is the coordinator's default address for the gRPC server to listen on.
	MeshAddrDefault = ":2001"
	// ClientAddr is the coordinator's address for the HTTP-REST server to listen on.
	ClientAddr = "EDG_COORDINATOR_CLIENT_ADDR"
	// ClientAddrDefault is the coordinator's default address for the HTTP-REST server to listen on.
	ClientAddrDefault = ":4433"
	// PromAddr is the coordinator's address for the prometheus endpoint server to listen on.
	PromAddr = "EDG_COORDINATOR_PROMETHEUS_ADDR"

	// DNSNames are the alternative dns names for the coordinator's certificate.
	DNSNames = "EDG_COORDINATOR_DNS_NAMES"
	// DNSNamesDefault are the default dns names for the coordinator's certificate.
	DNSNamesDefault = "localhost"

	// SealDir is the coordinator's file location to store the sealed state.
	SealDir = "EDG_COORDINATOR_SEAL_DIR"

	// DevMode enables more verbose logging.
	DevMode = "EDG_COORDINATOR_DEV_MODE"
	// DevModeDefault is the default logging mode.
	DevModeDefault = "0"

	// StartupManifest is a path to a manifest to start with instead of waiting for a manifest from the api.
	StartupManifest = "EDG_STARTUP_MANIFEST"
)

// SealDirDefault returns the coordinator's default file location to store the sealed state.
func SealDirDefault() string { return filepath.Join(util.MustGetwd(), "marblerun-coordinator-data") }