Skip to content

Commit 0a870ec

Browse files
authored
Merge pull request #6 from splunk-soar-connectors/next
Merging next to main for release 1.1.2
2 parents 88ef59b + 93be6f8 commit 0a870ec

File tree

11 files changed

+116
-86
lines changed

11 files changed

+116
-86
lines changed

.github/workflows/generate-doc.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Generate Readme Doc
2+
on:
3+
workflow_dispatch:
4+
push:
5+
paths:
6+
- '*.json'
7+
- 'readme.html'
8+
- 'manual_readme_content.md'
9+
tags-ignore:
10+
- '**'
11+
branches-ignore:
12+
- next
13+
- main
14+
jobs:
15+
generate-doc:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: 'phantomcyber/dev-cicd-tools/github-actions/generate-doc@main'
19+
with:
20+
GITHUB_TOKEN: ${{ secrets.SOAR_APPS_TOKEN }}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Review Release
2+
concurrency:
3+
group: app-release
4+
cancel-in-progress: true
5+
permissions:
6+
contents: read
7+
id-token: write
8+
statuses: write
9+
on:
10+
workflow_dispatch:
11+
inputs:
12+
task_token:
13+
description: 'StepFunction task token'
14+
required: true
15+
16+
jobs:
17+
review:
18+
uses: 'phantomcyber/dev-cicd-tools/.github/workflows/review-release.yml@main'
19+
with:
20+
task_token: ${{ inputs.task_token }}
21+
secrets:
22+
resume_release_role_arn: ${{ secrets.RESUME_RELEASE_ROLE_ARN }}

.github/workflows/start-release.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Start Release
2-
on: workflow_dispatch
2+
on:
3+
workflow_dispatch:
4+
push:
5+
tags:
6+
- '*-beta*'
37
jobs:
48
start-release:
59
runs-on: ubuntu-latest

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
repos:
22
- repo: https://github.com/phantomcyber/dev-cicd-tools
3-
rev: v1.6
3+
rev: v1.16
44
hooks:
55
- id: org-hook
66
- id: package-app-dependencies
77
- repo: https://github.com/Yelp/detect-secrets
8-
rev: v1.1.0
8+
rev: v1.4.0
99
hooks:
1010
- id: detect-secrets
1111
args: ['--no-verify', '--exclude-files', '^hashicorp_vault.json$']

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,4 @@
198198
distributed under the License is distributed on an "AS IS" BASIS,
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201-
limitations under the License.
201+
limitations under the License.

README.md

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
# Hashicorp Vault
33

44
Publisher: Splunk Community
5-
Connector Version: 1\.1\.1
5+
Connector Version: 1.1.2
66
Product Vendor: Dallan
77
Product Name: Hashicorp Vault
8-
Product Version Supported (regex): "\.\*"
9-
Minimum Product Version: 5\.0\.0
8+
Product Version Supported (regex): ".\*"
9+
Minimum Product Version: 5.0.0
1010

1111
This is an app that supports various interactions with the Hashicorp Vault REST API
1212

@@ -38,13 +38,13 @@ The below configuration variables are required for this Connector to operate. T
3838

3939
VARIABLE | REQUIRED | TYPE | DESCRIPTION
4040
-------- | -------- | ---- | -----------
41-
**verify\_server\_cert** | optional | boolean | Verify server certificate
42-
**vault\_url** | required | string | URL of the Hashicorp Vault instance
43-
**vault\_mountpoint** | required | string | Vault mountpoint to connect with
44-
**vault\_token** | required | password | Token used to authenticate requests to Hashicorp Vault when using token authentication
45-
**vault\_namespace** | optional | string | Vault Namespace
46-
**vault\_role\_id** | optional | password | Role ID if using AppRole authentication
47-
**vault\_secret\_id** | optional | password | Secret ID if using AppRole authentication
41+
**verify_server_cert** | optional | boolean | Verify server certificate
42+
**vault_url** | required | string | URL of the Hashicorp Vault instance
43+
**vault_mountpoint** | required | string | Vault mountpoint to connect with
44+
**vault_token** | required | password | Token used to authenticate requests to Hashicorp Vault when using token authentication
45+
**vault_namespace** | optional | string | Vault Namespace
46+
**vault_role_id** | optional | password | Role ID if using AppRole authentication
47+
**vault_secret_id** | optional | password | Secret ID if using AppRole authentication
4848

4949
### Supported Actions
5050
[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using supplied credentials
@@ -75,20 +75,20 @@ PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
7575
--------- | -------- | ----------- | ---- | --------
7676
**location** | required | Location to keep the secret value | string | `hashicorp vault location`
7777
**update** | optional | Update secret value if already exists | boolean |
78-
**secret\_json** | required | JSON formatted object of dictionary to store at the given location | string |
78+
**secret_json** | required | JSON formatted object of dictionary to store at the given location | string |
7979

8080
#### Action Output
81-
DATA PATH | TYPE | CONTAINS
82-
--------- | ---- | --------
83-
action\_result\.parameter\.location | string | `hashicorp vault location`
84-
action\_result\.parameter\.secret\_json | string |
85-
action\_result\.parameter\.update | boolean |
86-
action\_result\.data\.\*\.succeeded | boolean |
87-
action\_result\.status | string |
88-
action\_result\.summary | string |
89-
action\_result\.message | string |
90-
summary\.total\_objects | numeric |
91-
summary\.total\_objects\_successful | numeric |
81+
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
82+
--------- | ---- | -------- | --------------
83+
action_result.parameter.location | string | `hashicorp vault location` |
84+
action_result.parameter.secret_json | string | |
85+
action_result.parameter.update | boolean | | True False
86+
action_result.data.\*.succeeded | boolean | | True False
87+
action_result.status | string | | success failed
88+
action_result.summary | string | |
89+
action_result.message | string | |
90+
summary.total_objects | numeric | | 1
91+
summary.total_objects_successful | numeric | | 1
9292

9393
## action: 'get secret'
9494
Get secret value present at the specified path
@@ -102,16 +102,16 @@ PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
102102
**location** | required | Location of the secret value | string | `hashicorp vault location`
103103

104104
#### Action Output
105-
DATA PATH | TYPE | CONTAINS
106-
--------- | ---- | --------
107-
action\_result\.parameter\.location | string | `hashicorp vault location`
108-
action\_result\.data\.\*\.secret\_value | string |
109-
action\_result\.data\.\*\.succeeded | boolean |
110-
action\_result\.status | string |
111-
action\_result\.summary | string |
112-
action\_result\.message | string |
113-
summary\.total\_objects | numeric |
114-
summary\.total\_objects\_successful | numeric |
105+
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
106+
--------- | ---- | -------- | --------------
107+
action_result.parameter.location | string | `hashicorp vault location` |
108+
action_result.data.\*.secret_value | string | |
109+
action_result.data.\*.succeeded | boolean | | True False
110+
action_result.status | string | | success failed
111+
action_result.summary | string | |
112+
action_result.message | string | |
113+
summary.total_objects | numeric | | 1
114+
summary.total_objects_successful | numeric | | 1
115115

116116
## action: 'list secrets'
117117
List secret values present at the specified path
@@ -125,13 +125,13 @@ PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
125125
**location** | required | Location of the secret values | string | `hashicorp vault location`
126126

127127
#### Action Output
128-
DATA PATH | TYPE | CONTAINS
129-
--------- | ---- | --------
130-
action\_result\.parameter\.location | string | `hashicorp vault location`
131-
action\_result\.data\.\*\.secret\_values | string |
132-
action\_result\.data\.\*\.succeeded | boolean |
133-
action\_result\.status | string |
134-
action\_result\.summary | string |
135-
action\_result\.message | string |
136-
summary\.total\_objects | numeric |
137-
summary\.total\_objects\_successful | numeric |
128+
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
129+
--------- | ---- | -------- | --------------
130+
action_result.parameter.location | string | `hashicorp vault location` |
131+
action_result.data.\*.secret_values | string | |
132+
action_result.data.\*.succeeded | boolean | | True False
133+
action_result.status | string | | success failed
134+
action_result.summary | string | |
135+
action_result.message | string | |
136+
summary.total_objects | numeric | | 1
137+
summary.total_objects_successful | numeric | | 1

hashicorp_vault.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"publisher": "Splunk Community",
66
"type": "generic",
77
"main_module": "hashicorp_vault_connector.py",
8-
"app_version": "1.1.1",
9-
"utctime_updated": "2022-01-11T12:34:18.000000Z",
8+
"app_version": "1.1.2",
9+
"utctime_updated": "2024-06-13T15:56:30.000000Z",
1010
"package_name": "phantom_hashicorp_vault",
1111
"product_vendor": "Dallan",
1212
"product_name": "Hashicorp Vault",

hashicorp_vault_connector.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,6 @@ def _set_secret(self, param, action_result):
154154
mountpoint = self._get_mountpoint()
155155
path = param.get('location')
156156
secret = param.get('secret_json')
157-
self.save_progress(secret)
158157
try:
159158
secret = json.loads(secret)
160159
try:

manual_readme_content.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[comment]: # " File: README.md"
2+
[comment]: # " Copyright (c) 2020-2022 Splunk Inc."
3+
[comment]: # " Licensed under the Apache License, Version 2.0 (the 'License');"
4+
[comment]: # " you may not use this file except in compliance with the License."
5+
[comment]: # " You may obtain a copy of the License at"
6+
[comment]: # ""
7+
[comment]: # " http://www.apache.org/licenses/LICENSE-2.0"
8+
[comment]: # " Unless required by applicable law or agreed to in writing, software distributed under"
9+
[comment]: # " the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,"
10+
[comment]: # " either express or implied. See the License for the specific language governing permissions"
11+
[comment]: # " and limitations under the License."
12+
[comment]: # ""
13+
## Port Information
14+
15+
The app uses HTTP/ HTTPS protocol for communicating with the Hashicorp Vault server. Below are the
16+
default ports used by the Splunk SOAR Connector.
17+
18+
| SERVICE NAME | TRANSPORT PROTOCOL | PORT |
19+
|--------------|--------------------|------|
20+
| http | tcp | 80 |
21+
| https | tcp | 443 |

readme.html

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)