90870c11be
Add database models that deal with github credentials. This change adds models for github endpoints (github.com, GHES, etc). This change also adds code to migrate config credntials to the DB. Tests need to be fixed and new tests need to be written. This will come in a later commit. Signed-off-by: Gabriel Adrian Samfira <gsamfira@cloudbasesolutions.com>
334 lines
10 KiB
Go
334 lines
10 KiB
Go
// Copyright 2022 Cloudbase Solutions SRL
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
// not use this file except in compliance with the License. You may obtain
|
|
// a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
// License for the specific language governing permissions and limitations
|
|
// under the License.
|
|
|
|
package params
|
|
|
|
import (
|
|
"crypto/x509"
|
|
"encoding/json"
|
|
"encoding/pem"
|
|
"fmt"
|
|
|
|
"github.com/cloudbase/garm-provider-common/errors"
|
|
commonParams "github.com/cloudbase/garm-provider-common/params"
|
|
)
|
|
|
|
const DefaultRunnerPrefix = "garm"
|
|
|
|
type InstanceRequest struct {
|
|
Name string `json:"name"`
|
|
OSType commonParams.OSType `json:"os_type"`
|
|
OSVersion string `json:"os_version"`
|
|
}
|
|
|
|
type CreateRepoParams struct {
|
|
Owner string `json:"owner"`
|
|
Name string `json:"name"`
|
|
CredentialsName string `json:"credentials_name"`
|
|
WebhookSecret string `json:"webhook_secret"`
|
|
PoolBalancerType PoolBalancerType `json:"pool_balancer_type"`
|
|
}
|
|
|
|
func (c *CreateRepoParams) Validate() error {
|
|
if c.Owner == "" {
|
|
return errors.NewBadRequestError("missing owner")
|
|
}
|
|
|
|
if c.Name == "" {
|
|
return errors.NewBadRequestError("missing repo name")
|
|
}
|
|
|
|
if c.CredentialsName == "" {
|
|
return errors.NewBadRequestError("missing credentials name")
|
|
}
|
|
if c.WebhookSecret == "" {
|
|
return errors.NewMissingSecretError("missing secret")
|
|
}
|
|
|
|
switch c.PoolBalancerType {
|
|
case PoolBalancerTypeRoundRobin, PoolBalancerTypePack, PoolBalancerTypeNone:
|
|
default:
|
|
return errors.NewBadRequestError("invalid pool balancer type")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type CreateOrgParams struct {
|
|
Name string `json:"name"`
|
|
CredentialsName string `json:"credentials_name"`
|
|
WebhookSecret string `json:"webhook_secret"`
|
|
PoolBalancerType PoolBalancerType `json:"pool_balancer_type"`
|
|
}
|
|
|
|
func (c *CreateOrgParams) Validate() error {
|
|
if c.Name == "" {
|
|
return errors.NewBadRequestError("missing org name")
|
|
}
|
|
|
|
if c.CredentialsName == "" {
|
|
return errors.NewBadRequestError("missing credentials name")
|
|
}
|
|
if c.WebhookSecret == "" {
|
|
return errors.NewMissingSecretError("missing secret")
|
|
}
|
|
|
|
switch c.PoolBalancerType {
|
|
case PoolBalancerTypeRoundRobin, PoolBalancerTypePack, PoolBalancerTypeNone:
|
|
default:
|
|
return errors.NewBadRequestError("invalid pool balancer type")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type CreateEnterpriseParams struct {
|
|
Name string `json:"name"`
|
|
CredentialsName string `json:"credentials_name"`
|
|
WebhookSecret string `json:"webhook_secret"`
|
|
PoolBalancerType PoolBalancerType `json:"pool_balancer_type"`
|
|
}
|
|
|
|
func (c *CreateEnterpriseParams) Validate() error {
|
|
if c.Name == "" {
|
|
return errors.NewBadRequestError("missing enterprise name")
|
|
}
|
|
if c.CredentialsName == "" {
|
|
return errors.NewBadRequestError("missing credentials name")
|
|
}
|
|
if c.WebhookSecret == "" {
|
|
return errors.NewMissingSecretError("missing secret")
|
|
}
|
|
|
|
switch c.PoolBalancerType {
|
|
case PoolBalancerTypeRoundRobin, PoolBalancerTypePack, PoolBalancerTypeNone:
|
|
default:
|
|
return errors.NewBadRequestError("invalid pool balancer type")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// NewUserParams holds the needed information to create
|
|
// a new user
|
|
type NewUserParams struct {
|
|
Email string `json:"email"`
|
|
Username string `json:"username"`
|
|
FullName string `json:"full_name"`
|
|
Password string `json:"password"`
|
|
IsAdmin bool `json:"-"`
|
|
Enabled bool `json:"-"`
|
|
}
|
|
|
|
type UpdatePoolParams struct {
|
|
RunnerPrefix
|
|
|
|
Tags []string `json:"tags,omitempty"`
|
|
Enabled *bool `json:"enabled,omitempty"`
|
|
MaxRunners *uint `json:"max_runners,omitempty"`
|
|
MinIdleRunners *uint `json:"min_idle_runners,omitempty"`
|
|
RunnerBootstrapTimeout *uint `json:"runner_bootstrap_timeout,omitempty"`
|
|
Image string `json:"image"`
|
|
Flavor string `json:"flavor"`
|
|
OSType commonParams.OSType `json:"os_type"`
|
|
OSArch commonParams.OSArch `json:"os_arch"`
|
|
ExtraSpecs json.RawMessage `json:"extra_specs,omitempty"`
|
|
// GithubRunnerGroup is the github runner group in which the runners of this
|
|
// pool will be added to.
|
|
// The runner group must be created by someone with access to the enterprise.
|
|
GitHubRunnerGroup *string `json:"github-runner-group,omitempty"`
|
|
Priority *uint `json:"priority,omitempty"`
|
|
}
|
|
|
|
type CreateInstanceParams struct {
|
|
Name string
|
|
OSType commonParams.OSType
|
|
OSArch commonParams.OSArch
|
|
Status commonParams.InstanceStatus
|
|
RunnerStatus RunnerStatus
|
|
CallbackURL string
|
|
MetadataURL string
|
|
// GithubRunnerGroup is the github runner group to which the runner belongs.
|
|
// The runner group must be created by someone with access to the enterprise.
|
|
GitHubRunnerGroup string
|
|
CreateAttempt int `json:"-"`
|
|
AgentID int64 `json:"-"`
|
|
AditionalLabels []string
|
|
JitConfiguration map[string]string
|
|
}
|
|
|
|
type CreatePoolParams struct {
|
|
RunnerPrefix
|
|
|
|
ProviderName string `json:"provider_name"`
|
|
MaxRunners uint `json:"max_runners"`
|
|
MinIdleRunners uint `json:"min_idle_runners"`
|
|
Image string `json:"image"`
|
|
Flavor string `json:"flavor"`
|
|
OSType commonParams.OSType `json:"os_type"`
|
|
OSArch commonParams.OSArch `json:"os_arch"`
|
|
Tags []string `json:"tags"`
|
|
Enabled bool `json:"enabled"`
|
|
RunnerBootstrapTimeout uint `json:"runner_bootstrap_timeout"`
|
|
ExtraSpecs json.RawMessage `json:"extra_specs,omitempty"`
|
|
// GithubRunnerGroup is the github runner group in which the runners of this
|
|
// pool will be added to.
|
|
// The runner group must be created by someone with access to the enterprise.
|
|
GitHubRunnerGroup string `json:"github-runner-group"`
|
|
Priority uint `json:"priority"`
|
|
}
|
|
|
|
func (p *CreatePoolParams) Validate() error {
|
|
if p.ProviderName == "" {
|
|
return fmt.Errorf("missing provider")
|
|
}
|
|
|
|
if p.MinIdleRunners > p.MaxRunners {
|
|
return fmt.Errorf("min_idle_runners cannot be larger than max_runners")
|
|
}
|
|
|
|
if p.MaxRunners == 0 {
|
|
return fmt.Errorf("max_runners cannot be 0")
|
|
}
|
|
|
|
if len(p.Tags) == 0 {
|
|
return fmt.Errorf("missing tags")
|
|
}
|
|
|
|
if p.Flavor == "" {
|
|
return fmt.Errorf("missing flavor")
|
|
}
|
|
|
|
if p.Image == "" {
|
|
return fmt.Errorf("missing image")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type UpdateInstanceParams struct {
|
|
ProviderID string `json:"provider_id,omitempty"`
|
|
// OSName is the name of the OS. Eg: ubuntu, centos, etc.
|
|
OSName string `json:"os_name,omitempty"`
|
|
// OSVersion is the version of the operating system.
|
|
OSVersion string `json:"os_version,omitempty"`
|
|
// Addresses is a list of IP addresses the provider reports
|
|
// for this instance.
|
|
Addresses []commonParams.Address `json:"addresses,omitempty"`
|
|
// Status is the status of the instance inside the provider (eg: running, stopped, etc)
|
|
Status commonParams.InstanceStatus `json:"status,omitempty"`
|
|
RunnerStatus RunnerStatus `json:"runner_status,omitempty"`
|
|
ProviderFault []byte `json:"provider_fault,omitempty"`
|
|
AgentID int64 `json:"-"`
|
|
CreateAttempt int `json:"-"`
|
|
TokenFetched *bool `json:"-"`
|
|
JitConfiguration map[string]string `json:"-"`
|
|
}
|
|
|
|
type UpdateUserParams struct {
|
|
FullName string `json:"full_name"`
|
|
Password string `json:"password"`
|
|
Enabled *bool `json:"enabled"`
|
|
}
|
|
|
|
// PasswordLoginParams holds information used during
|
|
// password authentication, that will be passed to a
|
|
// password login function
|
|
type PasswordLoginParams struct {
|
|
Username string `json:"username"`
|
|
Password string `json:"password"`
|
|
}
|
|
|
|
// Validate checks if the username and password are set
|
|
func (p PasswordLoginParams) Validate() error {
|
|
if p.Username == "" || p.Password == "" {
|
|
return errors.ErrUnauthorized
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type UpdateEntityParams struct {
|
|
CredentialsName string `json:"credentials_name"`
|
|
WebhookSecret string `json:"webhook_secret"`
|
|
PoolBalancerType PoolBalancerType `json:"pool_balancer_type"`
|
|
}
|
|
|
|
type InstanceUpdateMessage struct {
|
|
Status RunnerStatus `json:"status"`
|
|
Message string `json:"message"`
|
|
AgentID *int64 `json:"agent_id,omitempty"`
|
|
}
|
|
|
|
type CreateGithubEndpointParams struct {
|
|
Name string `json:"name"`
|
|
Description string `json:"description"`
|
|
APIBaseURL string `json:"api_base_url"`
|
|
UploadBaseURL string `json:"upload_base_url"`
|
|
BaseURL string `json:"base_url"`
|
|
CACertBundle []byte `json:"ca_cert_bundle"`
|
|
}
|
|
|
|
type UpdateGithubEndpointParams struct {
|
|
Description *string `json:"description"`
|
|
APIBaseURL *string `json:"api_base_url"`
|
|
UploadBaseURL *string `json:"upload_base_url"`
|
|
BaseURL *string `json:"base_url"`
|
|
CACertBundle []byte `json:"ca_cert_bundle"`
|
|
}
|
|
|
|
type GithubPAT struct {
|
|
OAuth2Token string `json:"oauth2_token"`
|
|
}
|
|
|
|
type GithubApp struct {
|
|
AppID int64 `json:"app_id"`
|
|
InstallationID int64 `json:"installation_id"`
|
|
PrivateKeyBytes []byte `json:"private_key_bytes"`
|
|
}
|
|
|
|
func (g GithubApp) Validate() error {
|
|
if g.AppID == 0 {
|
|
return errors.NewBadRequestError("missing app_id")
|
|
}
|
|
|
|
if g.InstallationID == 0 {
|
|
return errors.NewBadRequestError("missing installation_id")
|
|
}
|
|
|
|
if len(g.PrivateKeyBytes) == 0 {
|
|
return errors.NewBadRequestError("missing private_key_bytes")
|
|
}
|
|
|
|
block, _ := pem.Decode(g.PrivateKeyBytes)
|
|
// Parse the private key as PCKS1
|
|
_, err := x509.ParsePKCS1PrivateKey(block.Bytes)
|
|
if err != nil {
|
|
return fmt.Errorf("parsing private_key_path: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type CreateGithubCredentialsParams struct {
|
|
Name string `json:"name"`
|
|
Description string `json:"description"`
|
|
AuthType GithubAuthType `json:"auth_type"`
|
|
PAT GithubPAT `json:"pat,omitempty"`
|
|
App GithubApp `json:"app,omitempty"`
|
|
}
|
|
|
|
type UpdateGithubCredentialsParams struct {
|
|
Name *string `json:"name,omitempty"`
|
|
Description *string `json:"description,omitempty"`
|
|
PAT *GithubPAT `json:"pat,omitempty"`
|
|
App *GithubApp `json:"app,omitempty"`
|
|
}
|