psiphon-tunnel-core/psiphon/common/parameters/inproxy.go

/*
 * Copyright (c) 2023, Psiphon Inc.
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package parameters

import (
	"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common"
	"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/errors"
	"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/inproxy"
)

// InproxyBrokerSpecsValue is a list of in-proxy broker specs.
type InproxyBrokerSpecsValue []*InproxyBrokerSpec

// InproxyBrokerSpec specifies the configuration to use to establish a secure
// connection to an in-proxy broker.
type InproxyBrokerSpec struct {
	BrokerPublicKey             string
	BrokerRootObfuscationSecret string
	BrokerFrontingSpecs         FrontingSpecs
}

// Validate checks that the in-proxy broker specs values are well-formed.
func (specs InproxyBrokerSpecsValue) Validate(checkBrokerPublicKeyList *[]string) error {

	for _, spec := range specs {
		if _, err := inproxy.SessionPublicKeyFromString(spec.BrokerPublicKey); err != nil {
			return errors.Tracef("invalid broker public key: %w", err)
		}
		if checkBrokerPublicKeyList != nil && !common.Contains(*checkBrokerPublicKeyList, spec.BrokerPublicKey) {
			return errors.TraceNew("unknown broker public key")
		}
		if _, err := inproxy.ObfuscationSecretFromString(spec.BrokerRootObfuscationSecret); err != nil {
			return errors.Tracef("invalid broker root obfuscation secret: %w", err)
		}
		if len(spec.BrokerFrontingSpecs) == 0 {
			return errors.TraceNew("missing broker fronting spec")
		}
		err := spec.BrokerFrontingSpecs.Validate()
		if err != nil {
			return errors.Trace(err)
		}
	}
	return nil
}

// InproxyCompartmentIDsValue is a list of in-proxy common compartment IDs.
type InproxyCompartmentIDsValue []string

// Validate checks that the in-proxy common compartment ID values are
// well-formed.
func (IDs InproxyCompartmentIDsValue) Validate(checkCompartmentIDList *[]string) error {

	for _, ID := range IDs {
		if _, err := inproxy.IDFromString(ID); err != nil {
			return errors.Tracef("invalid compartment ID: %w", err)
		}
		if checkCompartmentIDList != nil && !common.Contains(*checkCompartmentIDList, ID) {
			return errors.TraceNew("unknown compartment ID")
		}
	}
	return nil
}

// InproxyDataChannelTrafficShapingParameters is type-compatible with
// common/inproxy.DataChannelTrafficShapingParameters.
type InproxyDataChannelTrafficShapingParametersValue struct {
	MinPaddedMessages       int
	MaxPaddedMessages       int
	MinPaddingSize          int
	MaxPaddingSize          int
	MinDecoyMessages        int
	MaxDecoyMessages        int
	MinDecoySize            int
	MaxDecoySize            int
	DecoyMessageProbability float64
}

func (p *InproxyDataChannelTrafficShapingParametersValue) Validate() error {
	if p.MinPaddedMessages < 0 ||
		p.MaxPaddedMessages < 0 ||
		p.MinPaddingSize < 0 ||
		p.MaxPaddingSize < 0 ||
		p.MinDecoyMessages < 0 ||
		p.MaxDecoyMessages < 0 ||
		p.MinDecoySize < 0 ||
		p.MaxDecoySize < 0 ||
		p.DecoyMessageProbability < 0.0 {
		return errors.TraceNew("invalid parameter")
	}
	return nil
}