-
Notifications
You must be signed in to change notification settings - Fork 1
/
skill.ts
122 lines (114 loc) · 3.38 KB
/
skill.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
* Copyright © 2023 Atomist, Inc.
*
* 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.
*/
import {
Category,
parameter,
ParameterType,
resourceProvider,
skill,
SkillInput,
} from "@atomist/skill";
import * as _ from "lodash";
import { loadPattern } from "./lib/load";
async function createSkill(): Promise<SkillInput<any>> {
return {
name: "github-secret-scanner-skill",
namespace: "atomist",
description:
"Scan committed code for well-known credentials and secrets",
displayName: "Secret Scanner",
categories: [Category.CodeMaintenance, Category.DevSecOps],
iconUrl:
"https://raw.githubusercontent.com/atomist-skills/github-secret-scanner-skill/main/docs/images/icon.svg",
containers: {
scan: {
image: "gcr.io/atomist-container-skills/github-secret-scanner-skill",
resources: {
limit: {
cpu: 2,
memory: 4000,
},
},
},
},
resourceProviders: {
github: resourceProvider.gitHub({ minRequired: 1 }),
slack: resourceProvider.chat({ minRequired: 0 }),
},
parameters: {
failCheck: {
type: ParameterType.Boolean,
displayName: "Fail GitHub check",
description:
"Set a failed GitHub check when secrets are found or changed; otherwise a neutral check will be set",
defaultValue: false,
required: false,
},
glob: {
type: ParameterType.StringArray,
displayName: "Which files to scan",
description:
"Enter the files you want to scan as a glob pattern.",
required: false,
defaultValue: ["**/*"],
},
pattern: {
type: ParameterType.StringArray,
displayName: "Custom secret patterns",
description:
"Enter your own patterns to scan for as [regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Cheatsheet). Learn more about how to match your [secret format](https://regex101.com/).",
required: false,
},
disabled: {
type: ParameterType.MultiChoice,
displayName: "Disable default secret patterns",
description:
"Select the patterns you do not want to scan for from our list of known secrets.",
required: false,
options: _.sortBy(
(await loadPattern()).map(s => ({
text: s.description,
value: s.description,
})),
"text",
),
},
exceptions: {
type: ParameterType.StringArray,
displayName: "Secret values to exclude",
description:
"Enter the secret values you want to exclude from reporting.",
required: false,
},
channels: {
type: ParameterType.ChatChannels,
displayName: "Chat channels to notify",
description:
"Select chat channels that should receive notifications on detected secrets",
minRequired: 0,
required: false,
},
repos: parameter.repoFilter(),
},
datalogSubscriptions: [
{
query: "@atomist/skill/on_push",
name: "scan_on_push",
},
],
};
}
export const Skill = skill<any>(createSkill());