gateway

package

v0.3.4 Latest Latest Go to latest Published: Jul 10, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

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

Repository

github.com/NeuralTrust/TrustGate

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func IsValidSlug(slug string) bool
func NewSlug() (string, error)
func NormalizeDomain(domain string) (string, error)
func NormalizeSlug(slug string) string
func SanitizeClientMetadata(metadata map[string]string) map[string]string
func WithTenantID(metadata map[string]string, tenantID string) map[string]string
type ClientTLSConfig
- func (c *ClientTLSConfig) Scan(value interface{}) error
- func (c ClientTLSConfig) Value() (driver.Value, error)
type Gateway
- func New(slug string) (*Gateway, error)
- func Rehydrate(id ids.GatewayID, slug, status, domain string, tel *telemetry.Telemetry, ...) *Gateway
- func (g *Gateway) TenantID() string
- func (g *Gateway) Validate() error
type ListFilter
type Repository
type SessionConfig
- func DefaultSessionConfig() *SessionConfig
- func (s *SessionConfig) IsEnabled() bool

Constants ¶

View Source

const MetadataTenantIDKey = "tenant_id"

Variables ¶

View Source

var (
	ErrNotFound      = fmt.Errorf("gateway: %w", commonerrors.ErrNotFound)
	ErrAlreadyExists = fmt.Errorf("gateway: %w", commonerrors.ErrAlreadyExists)
	ErrHasDependents = fmt.Errorf("gateway: %w", commonerrors.ErrHasDependents)
	ErrInvalidDomain = fmt.Errorf("gateway: invalid domain: %w", commonerrors.ErrValidation)
)

Sentinel errors for the gateway aggregate. They wrap the package-wide sentinels in pkg/common/errors so callers can match either the generic or the entity-specific error via errors.Is.

Functions ¶

func IsValidSlug ¶

func IsValidSlug(slug string) bool

func NewSlug ¶ added in v0.3.4

func NewSlug() (string, error)

NewSlug returns a random gateway slug that satisfies the DNS-label format (e.g. "gw-k3f9x1a2b7c4"). 36^12 combinations make collisions vanishingly rare; the slug unique index plus a retry on save covers the residual risk.

func NormalizeDomain ¶

func NormalizeDomain(domain string) (string, error)

func NormalizeSlug ¶

func NormalizeSlug(slug string) string

func SanitizeClientMetadata ¶ added in v0.3.4

func SanitizeClientMetadata(metadata map[string]string) map[string]string

func WithTenantID ¶ added in v0.3.4

func WithTenantID(metadata map[string]string, tenantID string) map[string]string

Types ¶

type ClientTLSConfig ¶

type ClientTLSConfig map[string]json.RawMessage

func (*ClientTLSConfig) Scan ¶

func (c *ClientTLSConfig) Scan(value interface{}) error

func (ClientTLSConfig) Value ¶

func (c ClientTLSConfig) Value() (driver.Value, error)

type Gateway ¶

type Gateway struct {
	ID              ids.GatewayID        `json:"id"`
	Slug            string               `json:"slug"`
	Status          string               `json:"status"`
	Domain          string               `json:"domain,omitempty"`
	Metadata        map[string]string    `json:"metadata,omitempty"`
	Telemetry       *telemetry.Telemetry `json:"telemetry,omitempty"`
	ClientTLSConfig ClientTLSConfig      `json:"client_tls,omitempty"`
	SessionConfig   *SessionConfig       `json:"session_config,omitempty"`
	CreatedAt       time.Time            `json:"created_at"`
	UpdatedAt       time.Time            `json:"updated_at"`
}

func New ¶

func New(slug string) (*Gateway, error)

func Rehydrate ¶

func Rehydrate(
	id ids.GatewayID,
	slug, status, domain string,
	tel *telemetry.Telemetry,
	clientTLS ClientTLSConfig,
	session *SessionConfig,
	createdAt, updatedAt time.Time,
) *Gateway

func (*Gateway) TenantID ¶ added in v0.3.4

func (g *Gateway) TenantID() string

func (*Gateway) Validate ¶

func (g *Gateway) Validate() error

type ListFilter ¶

type ListFilter struct {
	SlugContains string
	Page         int
	Size         int
}

type Repository ¶

type Repository interface {
	Save(ctx context.Context, g *Gateway) error
	Update(ctx context.Context, g *Gateway) error
	Delete(ctx context.Context, id ids.GatewayID) error
	FindByID(ctx context.Context, id ids.GatewayID) (*Gateway, error)
	FindByDomain(ctx context.Context, domain string) (*Gateway, error)
	FindBySlug(ctx context.Context, slug string) (*Gateway, error)
	List(ctx context.Context, filter ListFilter) (items []*Gateway, total int, err error)
}

type SessionConfig ¶

type SessionConfig struct {
	Enabled       *bool  `json:"enabled,omitempty"`
	HeaderName    string `json:"header_name,omitempty"`
	BodyParamName string `json:"body_param_name,omitempty"`
}

func DefaultSessionConfig ¶

func DefaultSessionConfig() *SessionConfig

func (*SessionConfig) IsEnabled ¶

func (s *SessionConfig) IsEnabled() bool

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mocks

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