directory.go

// KIProtect Hyper
// Copyright (C) 2021-2023 KIProtect GmbH
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package forms

import (
	"fmt"
	"github.com/kiprotect/go-helpers/forms"
	"regexp"
)

var OperatorChannelForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "type",
			Validators: []forms.Validator{
				forms.IsString{},
				// we do not validate the channel type because it can contain
				// channel types that are not implemented by the local server
				// which does not mean that they can't exist though...
			},
		},
		{
			Name: "settings",
			Validators: []forms.Validator{
				forms.IsOptional{},
				forms.IsStringMap{},
			},
		},
	},
}

var OperatorCertificateForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "fingerprint",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "key_usage",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
	},
}

var ServiceValidatorForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "type",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "parameters",
			Validators: []forms.Validator{
				forms.IsOptional{},
				forms.IsStringMap{},
			},
		},
	},
}

var ServiceMethodForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "name",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "permissions",
			Validators: []forms.Validator{
				forms.IsOptional{Default: []interface{}{}},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &PermissionForm,
						},
					},
				},
			},
		},
		{
			Name: "parameters",
			Validators: []forms.Validator{
				forms.IsOptional{},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &MethodParameterForm,
						},
					},
				},
			},
		},
	},
}

var MethodParameterForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "name",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "validators",
			Validators: []forms.Validator{
				forms.IsOptional{},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &ServiceValidatorForm,
						},
					},
				},
			},
		},
	},
}

type IsValidRightsList struct{}

func (f IsValidRightsList) Validate(value interface{}, values map[string]interface{}) (interface{}, error) {
	// string validation happened before
	rights := value.([]string)

	mapValues := map[string]bool{}

	// we check that the permissions are valid
	for _, right := range rights {
		if _, ok := mapValues[right]; ok {
			return nil, fmt.Errorf("duplicate 'rights' string")
		} else {
			mapValues[right] = true
		}
	}

	return rights, nil
}

var PermissionForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "group",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "rights",
			Validators: []forms.Validator{
				forms.IsStringList{
					Validators: []forms.Validator{
						forms.IsIn{Choices: []interface{}{"call"}},
					},
				},
				IsValidRightsList{},
			},
		},
	},
}

var OperatorSettingsForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "operator",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
			},
		},
		{
			Name: "service",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
			},
		},
		{
			Name: "environment",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
			},
		},
		{
			Name: "settings",
			Validators: []forms.Validator{
				forms.IsStringMap{}, // to do: restrict size of settings (?)
			},
		},
	},
}

var OperatorPreferencesForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "operator",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
			},
		},
		{
			Name: "service",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
			},
		},
		{
			Name: "environment",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
			},
		},
		{
			Name: "settings",
			Validators: []forms.Validator{
				forms.IsStringMap{}, // to do: restrict size of settings (?)
			},
		},
	},
}
var OperatorServiceForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "name",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "permissions",
			Validators: []forms.Validator{
				forms.IsOptional{Default: []interface{}{}},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &PermissionForm,
						},
					},
				},
			},
		},
		{
			Name: "methods",
			Validators: []forms.Validator{
				forms.IsOptional{Default: []interface{}{}},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &ServiceMethodForm,
						},
					},
				},
			},
		},
	},
}

var DirectoryEntryForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "name",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "channels",
			Validators: []forms.Validator{
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &OperatorChannelForm,
						},
					},
				},
			},
		},
		{
			Name: "services",
			Validators: []forms.Validator{
				forms.IsOptional{Default: []interface{}{}},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &OperatorServiceForm,
						},
					},
				},
			},
		},
		{
			Name: "settings",
			Validators: []forms.Validator{
				forms.IsOptional{Default: []interface{}{}},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &OperatorSettingsForm,
						},
					},
				},
			},
		},
		{
			Name: "preferences",
			Validators: []forms.Validator{
				forms.IsOptional{Default: []interface{}{}},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &OperatorPreferencesForm,
						},
					},
				},
			},
		},
		{
			Name: "certificates",
			Validators: []forms.Validator{
				forms.IsOptional{Default: []interface{}{}},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &OperatorCertificateForm,
						},
					},
				},
			},
		},
	},
}

var SignedChangeRecordForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "hash",
			Validators: []forms.Validator{
				forms.IsHex{
					Strict:    true, // we don't allow any '-' characters
					MinLength: 32,   // this is the binary length
					MaxLength: 32,   // this is the binary length
				},
			},
		},
		{
			Name: "parent_hash",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
				forms.MatchesRegex{
					Regexp: regexp.MustCompile(`^([a-f0-9]{64}|)$`),
				},
			},
		},
		{
			Name: "signature",
			Validators: []forms.Validator{
				forms.IsStringMap{
					Form: &SignatureForm,
				},
			},
		},
		{
			Name: "record",
			Validators: []forms.Validator{
				forms.IsStringMap{
					Form: &ChangeRecordForm,
				},
			},
		},
	},
}

var ChangeRecordForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "name",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
		{
			Name: "created_at",
			Validators: []forms.Validator{
				forms.IsString{},
				forms.IsTime{
					Format: "rfc3339",
				},
			},
		},
		{
			Name: "section",
			Validators: []forms.Validator{
				forms.IsString{},
				forms.IsIn{
					Choices: []interface{}{"channels", "certificates", "services", "preferences", "settings", "groups"},
				},
			},
		},
		{
			Name: "data",
			Validators: []forms.Validator{
				forms.Switch{
					Key: "section",
					Cases: map[string][]forms.Validator{
						"channels": []forms.Validator{
							forms.IsList{
								Validators: []forms.Validator{
									forms.IsStringMap{
										Form: &OperatorChannelForm,
									},
								},
							},
						},
						"groups": []forms.Validator{
							forms.IsList{
								Validators: []forms.Validator{
									forms.IsString{},
								},
							},
						},
						"settings": []forms.Validator{
							forms.IsList{
								Validators: []forms.Validator{
									forms.IsStringMap{
										Form: &OperatorSettingsForm,
									},
								},
							},
						},
						"preferences": []forms.Validator{
							forms.IsList{
								Validators: []forms.Validator{
									forms.IsStringMap{
										Form: &OperatorPreferencesForm,
									},
								},
							},
						},
						"services": []forms.Validator{
							forms.IsList{
								Validators: []forms.Validator{
									forms.IsStringMap{
										Form: &OperatorServiceForm,
									},
								},
							},
						},
						"certificates": []forms.Validator{
							forms.IsList{
								Validators: []forms.Validator{
									forms.IsStringMap{
										Form: &OperatorCertificateForm,
									},
								},
							},
						},
					},
				},
			},
		},
	},
}