|
| 1 | +package security |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "errors" |
| 6 | + "fmt" |
| 7 | + "net/http" |
| 8 | + "sort" |
| 9 | + "strings" |
| 10 | + |
| 11 | + "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/client" |
| 12 | + "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/machines" |
| 13 | + "github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/checks" |
| 14 | + "github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/client_wrapper" |
| 15 | + "github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/config" |
| 16 | + "go.uber.org/zap" |
| 17 | +) |
| 18 | + |
| 19 | +const ( |
| 20 | + OctoLintSha1Certificates = "OctoLintSha1Certificates" |
| 21 | + sha1Alg = "sha1RSA" |
| 22 | +) |
| 23 | + |
| 24 | +// OctoLintSha1CertificatesCheck checks to see if any targets, workers or the server itself is using a sha1 certificate |
| 25 | +type OctoLintSha1CertificatesCheck struct { |
| 26 | + client *client.Client |
| 27 | + errorHandler checks.OctopusClientErrorHandler |
| 28 | + config *config.OctolintConfig |
| 29 | +} |
| 30 | + |
| 31 | +type Sha1CertificateResult struct { |
| 32 | + Name string |
| 33 | + Type string // "Target", "Worker", or "Global" |
| 34 | +} |
| 35 | + |
| 36 | +type ServerCertificate struct { |
| 37 | + ID string `json:"Id"` |
| 38 | + Name string `json:"Name"` |
| 39 | + Thumbprint string `json:"Thumbprint"` |
| 40 | + SignatureAlgorithm string `json:"SignatureAlgorithm"` |
| 41 | + Links map[string]string `json:"Links"` |
| 42 | +} |
| 43 | + |
| 44 | +func NewOctoLintSha1CertificatesCheck(client *client.Client, config *config.OctolintConfig, errorHandler checks.OctopusClientErrorHandler) OctoLintSha1CertificatesCheck { |
| 45 | + return OctoLintSha1CertificatesCheck{config: config, client: client, errorHandler: errorHandler} |
| 46 | +} |
| 47 | + |
| 48 | +func (o OctoLintSha1CertificatesCheck) Id() string { |
| 49 | + return OctoLintSha1Certificates |
| 50 | +} |
| 51 | + |
| 52 | +// fetchServerCertificate gets the server certificate object and returns it. |
| 53 | +func fetchServerCertificate(url, apiKey, accessToken string) (*ServerCertificate, error) { |
| 54 | + requestURL := fmt.Sprintf("%s/api/configuration/certificates/certificate-global", url) |
| 55 | + |
| 56 | + req, err := http.NewRequest(http.MethodGet, requestURL, nil) |
| 57 | + if err != nil { |
| 58 | + return nil, err |
| 59 | + } |
| 60 | + |
| 61 | + if apiKey != "" { |
| 62 | + req.Header.Set("X-Octopus-ApiKey", apiKey) |
| 63 | + } else if accessToken != "" { |
| 64 | + req.Header.Set("Authorization", "Bearer "+accessToken) |
| 65 | + } |
| 66 | + |
| 67 | + res, err := http.DefaultClient.Do(req) |
| 68 | + if err != nil { |
| 69 | + return nil, err |
| 70 | + } |
| 71 | + defer res.Body.Close() |
| 72 | + |
| 73 | + if res.StatusCode != http.StatusOK { |
| 74 | + return nil, fmt.Errorf("unexpected status code: %d", res.StatusCode) |
| 75 | + } |
| 76 | + |
| 77 | + var cert ServerCertificate |
| 78 | + if err := json.NewDecoder(res.Body).Decode(&cert); err != nil { |
| 79 | + return nil, err |
| 80 | + } |
| 81 | + |
| 82 | + return &cert, nil |
| 83 | +} |
| 84 | + |
| 85 | +// hasSha1Certificate checks if an endpoint has CertificateSignatureAlgorithm == sha1Alg |
| 86 | +func hasSha1Certificate(ep machines.IEndpoint) bool { |
| 87 | + if ep == nil { |
| 88 | + return false |
| 89 | + } |
| 90 | + |
| 91 | + switch e := ep.(type) { |
| 92 | + case *machines.ListeningTentacleEndpoint: |
| 93 | + return e.CertificateSignatureAlgorithm == sha1Alg |
| 94 | + case *machines.PollingTentacleEndpoint: |
| 95 | + return e.CertificateSignatureAlgorithm == sha1Alg |
| 96 | + default: |
| 97 | + return false |
| 98 | + } |
| 99 | +} |
| 100 | + |
| 101 | +// addSha1FromMachines is a top-level generic helper (function literals can't have type params). |
| 102 | +func addSha1FromMachines[T any]( |
| 103 | + results *[]Sha1CertificateResult, |
| 104 | + items []T, |
| 105 | + getName func(T) string, |
| 106 | + getEndpoint func(T) machines.IEndpoint, |
| 107 | + typ string, |
| 108 | +) { |
| 109 | + for _, item := range items { |
| 110 | + if hasSha1Certificate(getEndpoint(item)) { |
| 111 | + *results = append(*results, Sha1CertificateResult{Name: getName(item), Type: typ}) |
| 112 | + } |
| 113 | + } |
| 114 | +} |
| 115 | + |
| 116 | +func (o OctoLintSha1CertificatesCheck) Execute(concurrency int) (checks.OctopusCheckResult, error) { |
| 117 | + if o.client == nil { |
| 118 | + return nil, errors.New("octoclient is nil") |
| 119 | + } |
| 120 | + |
| 121 | + zap.L().Debug("Starting check " + o.Id()) |
| 122 | + defer func() { |
| 123 | + zap.L().Debug("Ended check " + o.Id()) |
| 124 | + }() |
| 125 | + |
| 126 | + var results []Sha1CertificateResult |
| 127 | + |
| 128 | + // Check server certificate |
| 129 | + cert, err := fetchServerCertificate(o.config.Url, o.config.ApiKey, o.config.AccessToken) |
| 130 | + if err != nil { |
| 131 | + return o.errorHandler.HandleError(o.Id(), checks.Security, err) |
| 132 | + } |
| 133 | + if cert != nil && cert.SignatureAlgorithm == sha1Alg { |
| 134 | + results = append(results, Sha1CertificateResult{Name: cert.Name, Type: "Global"}) |
| 135 | + } |
| 136 | + |
| 137 | + // Check deployment targets |
| 138 | + targets, err := client_wrapper.GetMachines(o.config.MaxSha1CertificatesMachines, o.client, o.client.GetSpaceID()) |
| 139 | + if err != nil { |
| 140 | + return o.errorHandler.HandleError(o.Id(), checks.Security, err) |
| 141 | + } |
| 142 | + addSha1FromMachines(&results, targets, |
| 143 | + func(m *machines.DeploymentTarget) string { return m.Name }, |
| 144 | + func(m *machines.DeploymentTarget) machines.IEndpoint { return m.Endpoint }, |
| 145 | + "Target", |
| 146 | + ) |
| 147 | + |
| 148 | + // Check workers |
| 149 | + workers, err := client_wrapper.GetWorkers(o.config.MaxSha1CertificatesMachines, o.client, o.client.GetSpaceID()) |
| 150 | + if err != nil { |
| 151 | + return o.errorHandler.HandleError(o.Id(), checks.Security, err) |
| 152 | + } |
| 153 | + addSha1FromMachines(&results, workers, |
| 154 | + func(w *machines.Worker) string { return w.Name }, |
| 155 | + func(w *machines.Worker) machines.IEndpoint { return w.Endpoint }, |
| 156 | + "Worker", |
| 157 | + ) |
| 158 | + |
| 159 | + // Provide results |
| 160 | + if len(results) > 0 { |
| 161 | + // Sort by Type then Name for stable output |
| 162 | + sort.Slice(results, func(i, j int) bool { |
| 163 | + if results[i].Type == results[j].Type { |
| 164 | + return results[i].Name < results[j].Name |
| 165 | + } |
| 166 | + return results[i].Type < results[j].Type |
| 167 | + }) |
| 168 | + |
| 169 | + lines := make([]string, len(results)) |
| 170 | + for i, m := range results { |
| 171 | + lines[i] = fmt.Sprintf("%s: %s", m.Type, m.Name) |
| 172 | + } |
| 173 | + |
| 174 | + return checks.NewOctopusCheckResultImpl( |
| 175 | + "The following resources use a SHA1 certificate:\n"+strings.Join(lines, "\n"), |
| 176 | + o.Id(), |
| 177 | + "", |
| 178 | + checks.Warning, |
| 179 | + checks.Security), nil |
| 180 | + } |
| 181 | + |
| 182 | + return checks.NewOctopusCheckResultImpl( |
| 183 | + "There are no uses of SHA1 certificates in targets, workers or the main Server Certificate", |
| 184 | + o.Id(), |
| 185 | + "", |
| 186 | + checks.Ok, |
| 187 | + checks.Security), nil |
| 188 | +} |
0 commit comments