socketsecurity 0.0.86__tar.gz → 0.0.88__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- socketsecurity-0.0.88/PKG-INFO +61 -0
- socketsecurity-0.0.88/README.md +38 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/__init__.py +1 -1
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/github.py +4 -2
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/socketcli.py +18 -2
- socketsecurity-0.0.88/socketsecurity.egg-info/PKG-INFO +61 -0
- socketsecurity-0.0.86/PKG-INFO +0 -52
- socketsecurity-0.0.86/README.md +0 -29
- socketsecurity-0.0.86/socketsecurity.egg-info/PKG-INFO +0 -52
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/LICENSE +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/pyproject.toml +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/setup.cfg +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/__init__.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/classes.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/exceptions.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/git_interface.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/gitlab.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/issues.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/licenses.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/messages.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity/core/scm_comments.py +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity.egg-info/SOURCES.txt +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity.egg-info/dependency_links.txt +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity.egg-info/entry_points.txt +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity.egg-info/requires.txt +0 -0
- {socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity.egg-info/top_level.txt +0 -0
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: socketsecurity
|
|
3
|
+
Version: 0.0.88
|
|
4
|
+
Summary: Socket Security CLI for CI/CD
|
|
5
|
+
Author-email: Douglas Coburn <douglas@socket.dev>
|
|
6
|
+
Maintainer-email: Douglas Coburn <douglas@socket.dev>
|
|
7
|
+
Project-URL: Homepage, https://socket.dev
|
|
8
|
+
Keywords: socketsecurity,socket.dev,sca,oss,security
|
|
9
|
+
Classifier: Development Status :: 4 - Beta
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Requires-Python: >=3.9
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Requires-Dist: requests
|
|
19
|
+
Requires-Dist: mdutils
|
|
20
|
+
Requires-Dist: prettytable
|
|
21
|
+
Requires-Dist: argparse
|
|
22
|
+
Requires-Dist: GitPython
|
|
23
|
+
|
|
24
|
+
# Socket Security CLI
|
|
25
|
+
|
|
26
|
+
The Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
```` shell
|
|
31
|
+
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER]
|
|
32
|
+
[--commit_message COMMIT_MESSAGE] [--default_branch] [--target_path TARGET_PATH] [--scm {api,github,gitlab}] [--sbom-file SBOM_FILE]
|
|
33
|
+
[--commit-sha COMMIT_SHA] [--generate-license GENERATE_LICENSE] [-v] [--enable-debug] [--enable-json] [--disable-overview]
|
|
34
|
+
[--disable-security-issue] [--files FILES]
|
|
35
|
+
````
|
|
36
|
+
|
|
37
|
+
If you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
| Parameter | Alternate Name | Required | Default | Description |
|
|
41
|
+
|:-------------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
42
|
+
| -h | --help | False | | Show the CLI help message |
|
|
43
|
+
| --api_token | | False | | Provides the Socket API Token |
|
|
44
|
+
| --repo | | True | | The string name in a git approved name for repositories. |
|
|
45
|
+
| --branch | | False | | The string name in a git approved name for branches. |
|
|
46
|
+
| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |
|
|
47
|
+
| --pr_number | | False | 0 | The integer for the PR or MR number |
|
|
48
|
+
| --commit_message | | False | | The string for a commit message if there is one |
|
|
49
|
+
| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |
|
|
50
|
+
| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |
|
|
51
|
+
| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |
|
|
52
|
+
| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |
|
|
53
|
+
| --version | -v | False | | Prints the version and exits |
|
|
54
|
+
| --enable-debug | | False | False | Enables debug messaging for the CLI |
|
|
55
|
+
| --sbom-file | | False | False | Creates a JSON file with all dependencies and alerts |
|
|
56
|
+
| --commit-sha | | False | | The commit hash for the commit |
|
|
57
|
+
| --generate-license | | False | False | If enabled with `--sbom-file` will include license details |
|
|
58
|
+
| --enable-json | | False | False | If enabled will change the console output format to JSON |
|
|
59
|
+
| --disable-overview | | False | False | If enabled will disable Dependency Overview comments |
|
|
60
|
+
| --disable-security-issue | | False | False | If enabled will disable Security Issue Comments |
|
|
61
|
+
| --files | | False | | If provided in the format of `["file1", "file2"]` it will only look for those files and not glob the path |
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Socket Security CLI
|
|
2
|
+
|
|
3
|
+
The Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```` shell
|
|
8
|
+
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER]
|
|
9
|
+
[--commit_message COMMIT_MESSAGE] [--default_branch] [--target_path TARGET_PATH] [--scm {api,github,gitlab}] [--sbom-file SBOM_FILE]
|
|
10
|
+
[--commit-sha COMMIT_SHA] [--generate-license GENERATE_LICENSE] [-v] [--enable-debug] [--enable-json] [--disable-overview]
|
|
11
|
+
[--disable-security-issue] [--files FILES]
|
|
12
|
+
````
|
|
13
|
+
|
|
14
|
+
If you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
| Parameter | Alternate Name | Required | Default | Description |
|
|
18
|
+
|:-------------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
19
|
+
| -h | --help | False | | Show the CLI help message |
|
|
20
|
+
| --api_token | | False | | Provides the Socket API Token |
|
|
21
|
+
| --repo | | True | | The string name in a git approved name for repositories. |
|
|
22
|
+
| --branch | | False | | The string name in a git approved name for branches. |
|
|
23
|
+
| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |
|
|
24
|
+
| --pr_number | | False | 0 | The integer for the PR or MR number |
|
|
25
|
+
| --commit_message | | False | | The string for a commit message if there is one |
|
|
26
|
+
| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |
|
|
27
|
+
| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |
|
|
28
|
+
| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |
|
|
29
|
+
| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |
|
|
30
|
+
| --version | -v | False | | Prints the version and exits |
|
|
31
|
+
| --enable-debug | | False | False | Enables debug messaging for the CLI |
|
|
32
|
+
| --sbom-file | | False | False | Creates a JSON file with all dependencies and alerts |
|
|
33
|
+
| --commit-sha | | False | | The commit hash for the commit |
|
|
34
|
+
| --generate-license | | False | False | If enabled with `--sbom-file` will include license details |
|
|
35
|
+
| --enable-json | | False | False | If enabled will change the console output format to JSON |
|
|
36
|
+
| --disable-overview | | False | False | If enabled will disable Dependency Overview comments |
|
|
37
|
+
| --disable-security-issue | | False | False | If enabled will disable Security Issue Comments |
|
|
38
|
+
| --files | | False | | If provided in the format of `["file1", "file2"]` it will only look for those files and not glob the path |
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
__author__ = 'socket.dev'
|
|
2
|
-
__version__ = '0.0.
|
|
2
|
+
__version__ = '0.0.88'
|
|
@@ -95,14 +95,16 @@ def do_request(
|
|
|
95
95
|
except Exception as error:
|
|
96
96
|
response = {
|
|
97
97
|
"error": error,
|
|
98
|
-
"response": response.text
|
|
98
|
+
"response": response.text,
|
|
99
|
+
"payload": payload
|
|
99
100
|
}
|
|
100
101
|
return response
|
|
101
102
|
else:
|
|
102
103
|
msg = {
|
|
103
104
|
"status_code": response.status_code,
|
|
104
105
|
"UnexpectedError": "There was an unexpected error using the API",
|
|
105
|
-
"error": response.text
|
|
106
|
+
"error": response.text,
|
|
107
|
+
"payload": payload
|
|
106
108
|
}
|
|
107
109
|
raise APIFailure(msg)
|
|
108
110
|
|
|
@@ -115,6 +115,20 @@ parser.add_argument(
|
|
|
115
115
|
default=False
|
|
116
116
|
)
|
|
117
117
|
|
|
118
|
+
parser.add_argument(
|
|
119
|
+
'--disable-overview',
|
|
120
|
+
help='Disables Dependency Overview comments',
|
|
121
|
+
action='store_true',
|
|
122
|
+
default=False
|
|
123
|
+
)
|
|
124
|
+
|
|
125
|
+
parser.add_argument(
|
|
126
|
+
'--disable-security-issue',
|
|
127
|
+
help='Disables Security Issues comment',
|
|
128
|
+
action='store_true',
|
|
129
|
+
default=False
|
|
130
|
+
)
|
|
131
|
+
|
|
118
132
|
parser.add_argument(
|
|
119
133
|
'--files',
|
|
120
134
|
help='Specify a list of files in the format of ["file1", "file2"]',
|
|
@@ -168,6 +182,8 @@ def main_code():
|
|
|
168
182
|
sbom_file = arguments.sbom_file
|
|
169
183
|
license_mode = arguments.generate_license
|
|
170
184
|
enable_json = arguments.enable_json
|
|
185
|
+
disable_overview = arguments.disable_overview
|
|
186
|
+
disable_security_issue = arguments.disable_security_issue
|
|
171
187
|
files = arguments.files
|
|
172
188
|
log.info(f"Starting Socket Security Scan version {__version__}")
|
|
173
189
|
api_token = os.getenv("SOCKET_SECURITY_API_KEY") or arguments.api_token
|
|
@@ -245,9 +261,9 @@ def main_code():
|
|
|
245
261
|
security_comment = Messages.security_comment_template(diff)
|
|
246
262
|
new_security_comment = True
|
|
247
263
|
new_overview_comment = True
|
|
248
|
-
if len(diff.new_alerts) == 0:
|
|
264
|
+
if len(diff.new_alerts) == 0 or disable_security_issue:
|
|
249
265
|
new_security_comment = False
|
|
250
|
-
if len(diff.new_packages) == 0 and diff.removed_packages == 0:
|
|
266
|
+
if (len(diff.new_packages) == 0 and diff.removed_packages == 0) or disable_overview:
|
|
251
267
|
new_overview_comment = False
|
|
252
268
|
scm.add_socket_comments(
|
|
253
269
|
security_comment,
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: socketsecurity
|
|
3
|
+
Version: 0.0.88
|
|
4
|
+
Summary: Socket Security CLI for CI/CD
|
|
5
|
+
Author-email: Douglas Coburn <douglas@socket.dev>
|
|
6
|
+
Maintainer-email: Douglas Coburn <douglas@socket.dev>
|
|
7
|
+
Project-URL: Homepage, https://socket.dev
|
|
8
|
+
Keywords: socketsecurity,socket.dev,sca,oss,security
|
|
9
|
+
Classifier: Development Status :: 4 - Beta
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Requires-Python: >=3.9
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Requires-Dist: requests
|
|
19
|
+
Requires-Dist: mdutils
|
|
20
|
+
Requires-Dist: prettytable
|
|
21
|
+
Requires-Dist: argparse
|
|
22
|
+
Requires-Dist: GitPython
|
|
23
|
+
|
|
24
|
+
# Socket Security CLI
|
|
25
|
+
|
|
26
|
+
The Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
```` shell
|
|
31
|
+
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER]
|
|
32
|
+
[--commit_message COMMIT_MESSAGE] [--default_branch] [--target_path TARGET_PATH] [--scm {api,github,gitlab}] [--sbom-file SBOM_FILE]
|
|
33
|
+
[--commit-sha COMMIT_SHA] [--generate-license GENERATE_LICENSE] [-v] [--enable-debug] [--enable-json] [--disable-overview]
|
|
34
|
+
[--disable-security-issue] [--files FILES]
|
|
35
|
+
````
|
|
36
|
+
|
|
37
|
+
If you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
| Parameter | Alternate Name | Required | Default | Description |
|
|
41
|
+
|:-------------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
42
|
+
| -h | --help | False | | Show the CLI help message |
|
|
43
|
+
| --api_token | | False | | Provides the Socket API Token |
|
|
44
|
+
| --repo | | True | | The string name in a git approved name for repositories. |
|
|
45
|
+
| --branch | | False | | The string name in a git approved name for branches. |
|
|
46
|
+
| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |
|
|
47
|
+
| --pr_number | | False | 0 | The integer for the PR or MR number |
|
|
48
|
+
| --commit_message | | False | | The string for a commit message if there is one |
|
|
49
|
+
| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |
|
|
50
|
+
| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |
|
|
51
|
+
| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |
|
|
52
|
+
| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |
|
|
53
|
+
| --version | -v | False | | Prints the version and exits |
|
|
54
|
+
| --enable-debug | | False | False | Enables debug messaging for the CLI |
|
|
55
|
+
| --sbom-file | | False | False | Creates a JSON file with all dependencies and alerts |
|
|
56
|
+
| --commit-sha | | False | | The commit hash for the commit |
|
|
57
|
+
| --generate-license | | False | False | If enabled with `--sbom-file` will include license details |
|
|
58
|
+
| --enable-json | | False | False | If enabled will change the console output format to JSON |
|
|
59
|
+
| --disable-overview | | False | False | If enabled will disable Dependency Overview comments |
|
|
60
|
+
| --disable-security-issue | | False | False | If enabled will disable Security Issue Comments |
|
|
61
|
+
| --files | | False | | If provided in the format of `["file1", "file2"]` it will only look for those files and not glob the path |
|
socketsecurity-0.0.86/PKG-INFO
DELETED
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: socketsecurity
|
|
3
|
-
Version: 0.0.86
|
|
4
|
-
Summary: Socket Security CLI for CI/CD
|
|
5
|
-
Author-email: Douglas Coburn <douglas@socket.dev>
|
|
6
|
-
Maintainer-email: Douglas Coburn <douglas@socket.dev>
|
|
7
|
-
Project-URL: Homepage, https://socket.dev
|
|
8
|
-
Keywords: socketsecurity,socket.dev,sca,oss,security
|
|
9
|
-
Classifier: Development Status :: 4 - Beta
|
|
10
|
-
Classifier: Intended Audience :: Developers
|
|
11
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
-
Requires-Python: >=3.9
|
|
16
|
-
Description-Content-Type: text/markdown
|
|
17
|
-
License-File: LICENSE
|
|
18
|
-
Requires-Dist: requests
|
|
19
|
-
Requires-Dist: mdutils
|
|
20
|
-
Requires-Dist: prettytable
|
|
21
|
-
Requires-Dist: argparse
|
|
22
|
-
Requires-Dist: GitPython
|
|
23
|
-
|
|
24
|
-
# Socket Security CLI
|
|
25
|
-
|
|
26
|
-
The Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.
|
|
27
|
-
|
|
28
|
-
## Usage
|
|
29
|
-
|
|
30
|
-
```` shell
|
|
31
|
-
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER] [--commit_message COMMIT_MESSAGE] [--default_branch DEFAULT_BRANCH]
|
|
32
|
-
[--target_path TARGET_PATH] [--mode {diff,new,license}] [--scm {api,github}] [--generate-license GENERATE_LICENSE]
|
|
33
|
-
````
|
|
34
|
-
|
|
35
|
-
If you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
| Parameter | Alternate Name | Required | Default | Description |
|
|
39
|
-
|:-------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
40
|
-
| -h | --help | False | | Show the CLI help message |
|
|
41
|
-
| --api_token | | False | | Provides the Socket API Token |
|
|
42
|
-
| --repo | | True | | The string name in a git approved name for repositories. |
|
|
43
|
-
| --branch | | False | | The string name in a git approved name for branches. |
|
|
44
|
-
| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |
|
|
45
|
-
| --pr_number | | False | 0 | The integer for the PR or MR number |
|
|
46
|
-
| --commit_message | | False | | The string for a commit message if there is one |
|
|
47
|
-
| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |
|
|
48
|
-
| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |
|
|
49
|
-
| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |
|
|
50
|
-
| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |
|
|
51
|
-
| --version | -v | False | | Prints the version and exits |
|
|
52
|
-
| --enable-debug | | False | False | Enables debug messaging for the CLI |
|
socketsecurity-0.0.86/README.md
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# Socket Security CLI
|
|
2
|
-
|
|
3
|
-
The Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.
|
|
4
|
-
|
|
5
|
-
## Usage
|
|
6
|
-
|
|
7
|
-
```` shell
|
|
8
|
-
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER] [--commit_message COMMIT_MESSAGE] [--default_branch DEFAULT_BRANCH]
|
|
9
|
-
[--target_path TARGET_PATH] [--mode {diff,new,license}] [--scm {api,github}] [--generate-license GENERATE_LICENSE]
|
|
10
|
-
````
|
|
11
|
-
|
|
12
|
-
If you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
| Parameter | Alternate Name | Required | Default | Description |
|
|
16
|
-
|:-------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
17
|
-
| -h | --help | False | | Show the CLI help message |
|
|
18
|
-
| --api_token | | False | | Provides the Socket API Token |
|
|
19
|
-
| --repo | | True | | The string name in a git approved name for repositories. |
|
|
20
|
-
| --branch | | False | | The string name in a git approved name for branches. |
|
|
21
|
-
| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |
|
|
22
|
-
| --pr_number | | False | 0 | The integer for the PR or MR number |
|
|
23
|
-
| --commit_message | | False | | The string for a commit message if there is one |
|
|
24
|
-
| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |
|
|
25
|
-
| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |
|
|
26
|
-
| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |
|
|
27
|
-
| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |
|
|
28
|
-
| --version | -v | False | | Prints the version and exits |
|
|
29
|
-
| --enable-debug | | False | False | Enables debug messaging for the CLI |
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: socketsecurity
|
|
3
|
-
Version: 0.0.86
|
|
4
|
-
Summary: Socket Security CLI for CI/CD
|
|
5
|
-
Author-email: Douglas Coburn <douglas@socket.dev>
|
|
6
|
-
Maintainer-email: Douglas Coburn <douglas@socket.dev>
|
|
7
|
-
Project-URL: Homepage, https://socket.dev
|
|
8
|
-
Keywords: socketsecurity,socket.dev,sca,oss,security
|
|
9
|
-
Classifier: Development Status :: 4 - Beta
|
|
10
|
-
Classifier: Intended Audience :: Developers
|
|
11
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
-
Requires-Python: >=3.9
|
|
16
|
-
Description-Content-Type: text/markdown
|
|
17
|
-
License-File: LICENSE
|
|
18
|
-
Requires-Dist: requests
|
|
19
|
-
Requires-Dist: mdutils
|
|
20
|
-
Requires-Dist: prettytable
|
|
21
|
-
Requires-Dist: argparse
|
|
22
|
-
Requires-Dist: GitPython
|
|
23
|
-
|
|
24
|
-
# Socket Security CLI
|
|
25
|
-
|
|
26
|
-
The Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.
|
|
27
|
-
|
|
28
|
-
## Usage
|
|
29
|
-
|
|
30
|
-
```` shell
|
|
31
|
-
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER] [--commit_message COMMIT_MESSAGE] [--default_branch DEFAULT_BRANCH]
|
|
32
|
-
[--target_path TARGET_PATH] [--mode {diff,new,license}] [--scm {api,github}] [--generate-license GENERATE_LICENSE]
|
|
33
|
-
````
|
|
34
|
-
|
|
35
|
-
If you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
| Parameter | Alternate Name | Required | Default | Description |
|
|
39
|
-
|:-------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
40
|
-
| -h | --help | False | | Show the CLI help message |
|
|
41
|
-
| --api_token | | False | | Provides the Socket API Token |
|
|
42
|
-
| --repo | | True | | The string name in a git approved name for repositories. |
|
|
43
|
-
| --branch | | False | | The string name in a git approved name for branches. |
|
|
44
|
-
| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |
|
|
45
|
-
| --pr_number | | False | 0 | The integer for the PR or MR number |
|
|
46
|
-
| --commit_message | | False | | The string for a commit message if there is one |
|
|
47
|
-
| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |
|
|
48
|
-
| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |
|
|
49
|
-
| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |
|
|
50
|
-
| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |
|
|
51
|
-
| --version | -v | False | | Prints the version and exits |
|
|
52
|
-
| --enable-debug | | False | False | Enables debug messaging for the CLI |
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{socketsecurity-0.0.86 → socketsecurity-0.0.88}/socketsecurity.egg-info/dependency_links.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|