Skip to content

Commit 8077989

Browse files
author
root
committed
Release notes for version 1.1.1
1 parent 2f295fb commit 8077989

File tree

4 files changed

+71
-63
lines changed

4 files changed

+71
-63
lines changed

‎README.md‎

Lines changed: 58 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,137 @@
11
[comment]: # "Auto-generated SOAR connector documentation"
22
# Hashicorp Vault
33

4-
Publisher: Splunk Community
5-
Connector Version: 1\.1\.0
6-
Product Vendor: Dallan
7-
Product Name: Hashicorp Vault
8-
Product Version Supported (regex): "\.\*"
9-
Minimum Product Version: 5\.0\.0
4+
Publisher: Splunk Community
5+
Connector Version: 1\.1\.1
6+
Product Vendor: Dallan
7+
Product Name: Hashicorp Vault
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

1313
[comment]: # " File: README.md"
14-
[comment]: # ""
1514
[comment]: # " Copyright (c) 2020-2022 Splunk Inc."
16-
[comment]: # ""
17-
[comment]: # " Licensed under the Apache License, Version 2.0 (the \"License\");"
15+
[comment]: # " Licensed under the Apache License, Version 2.0 (the 'License');"
1816
[comment]: # " you may not use this file except in compliance with the License."
1917
[comment]: # " You may obtain a copy of the License at"
2018
[comment]: # ""
2119
[comment]: # " http://www.apache.org/licenses/LICENSE-2.0"
22-
[comment]: # ""
2320
[comment]: # " Unless required by applicable law or agreed to in writing, software distributed under"
24-
[comment]: # " the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,"
21+
[comment]: # " the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,"
2522
[comment]: # " either express or implied. See the License for the specific language governing permissions"
2623
[comment]: # " and limitations under the License."
2724
[comment]: # ""
25+
## Port Information
2826

29-
**Port Information**
30-
* The app uses HTTP/ HTTPS protocol for communicating with the Hashicorp Vault server. Below are the default ports used by the Splunk SOAR Connector.
27+
The app uses HTTP/ HTTPS protocol for communicating with the Hashicorp Vault server. Below are the
28+
default ports used by the Splunk SOAR Connector.
29+
30+
| SERVICE NAME | TRANSPORT PROTOCOL | PORT |
31+
|--------------|--------------------|------|
32+
| http | tcp | 80 |
33+
| https | tcp | 443 |
3134

32-
SERVICE NAME | TRANSPORT PROTOCOL | PORT
33-
------------ | ------------------ | ----
34-
http | tcp | 80
35-
https | tcp | 443
3635

3736
### Configuration Variables
3837
The below configuration variables are required for this Connector to operate. These variables are specified when configuring a Hashicorp Vault asset in SOAR.
3938

4039
VARIABLE | REQUIRED | TYPE | DESCRIPTION
4140
-------- | -------- | ---- | -----------
42-
**verify\_server\_cert** | required | boolean | Verify server certificate
41+
**verify\_server\_cert** | optional | boolean | Verify server certificate
4342
**vault\_url** | required | string | URL of the Hashicorp Vault instance
4443
**vault\_mountpoint** | required | string | Vault mountpoint to connect with
45-
**vault\_token** | required | password | Token used to authenticate requests to Hashicorp Vault
44+
**vault\_token** | required | password | Token used to authenticate requests to Hashicorp Vault when using token authentication
4645
**vault\_namespace** | optional | string | Vault Namespace
4746
**vault\_role\_id** | optional | password | Role ID if using AppRole authentication
4847
**vault\_secret\_id** | optional | password | Secret ID if using AppRole authentication
4948

50-
51-
### Supported Actions
52-
[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using supplied credentials
53-
[set secret](#action-set-secret) - Set secret value at the specified path
54-
[get secret](#action-get-secret) - Get secret value present at the specified path
55-
[list secrets](#action-list-secrets) - List secret values present at the specified path
49+
### Supported Actions
50+
[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using supplied credentials
51+
[set secret](#action-set-secret) - Set secret value at the specified path
52+
[get secret](#action-get-secret) - Get secret value present at the specified path
53+
[list secrets](#action-list-secrets) - List secret values present at the specified path
5654

5755
## action: 'test connectivity'
5856
Validate the asset configuration for connectivity using supplied credentials
5957

60-
Type: **test**
58+
Type: **test**
6159
Read only: **True**
6260

6361
#### Action Parameters
6462
No parameters are required for this action
6563

6664
#### Action Output
67-
No Output
65+
No Output
6866

6967
## action: 'set secret'
7068
Set secret value at the specified path
7169

72-
Type: **generic**
70+
Type: **generic**
7371
Read only: **False**
7472

7573
#### Action Parameters
7674
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
7775
--------- | -------- | ----------- | ---- | --------
78-
**location** | required | Location to keep the secret value | string | `hashicorp vault location`
79-
**update** | required | Update secret value if already exists | boolean |
80-
**secret\_json** | required | JSON formatted object of dictionary to store at the given location | string |
76+
**location** | required | Location to keep the secret value | string | `hashicorp vault location`
77+
**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 |
8179

8280
#### Action Output
8381
DATA PATH | TYPE | CONTAINS
8482
--------- | ---- | --------
85-
action\_result\.parameter\.location | string | `hashicorp vault location`
86-
action\_result\.parameter\.update | boolean |
87-
action\_result\.parameter\.secret\_json | string |
88-
action\_result\.data\.\*\.succeeded | boolean |
89-
action\_result\.status | string |
90-
action\_result\.message | string |
91-
action\_result\.summary | string |
92-
summary\.total\_objects | numeric |
93-
summary\.total\_objects\_successful | numeric |
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 |
9492

9593
## action: 'get secret'
9694
Get secret value present at the specified path
9795

98-
Type: **investigate**
96+
Type: **investigate**
9997
Read only: **True**
10098

10199
#### Action Parameters
102100
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
103101
--------- | -------- | ----------- | ---- | --------
104-
**location** | required | Location of the secret value | string | `hashicorp vault location`
102+
**location** | required | Location of the secret value | string | `hashicorp vault location`
105103

106104
#### Action Output
107105
DATA PATH | TYPE | CONTAINS
108106
--------- | ---- | --------
109-
action\_result\.parameter\.location | string | `hashicorp vault location`
110-
action\_result\.data\.\*\.secret\_value | string |
111-
action\_result\.data\.\*\.succeeded | boolean |
112-
action\_result\.status | string |
113-
action\_result\.message | string |
114-
action\_result\.summary | string |
115-
summary\.total\_objects | numeric |
116-
summary\.total\_objects\_successful | numeric |
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 |
117115

118116
## action: 'list secrets'
119117
List secret values present at the specified path
120118

121-
Type: **investigate**
119+
Type: **investigate**
122120
Read only: **True**
123121

124122
#### Action Parameters
125123
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
126124
--------- | -------- | ----------- | ---- | --------
127-
**location** | required | Location of the secret values | string | `hashicorp vault location`
125+
**location** | required | Location of the secret values | string | `hashicorp vault location`
128126

129127
#### Action Output
130128
DATA PATH | TYPE | CONTAINS
131129
--------- | ---- | --------
132-
action\_result\.parameter\.location | string | `hashicorp vault location`
133-
action\_result\.data\.\*\.secret\_values | string |
134-
action\_result\.data\.\*\.succeeded | boolean |
135-
action\_result\.status | string |
136-
action\_result\.message | string |
137-
action\_result\.summary | string |
138-
summary\.total\_objects | numeric |
139-
summary\.total\_objects\_successful | numeric |
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 |

‎release_notes/1.1.1.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
**Hashicorp Vault Release Notes - Published by Splunk Community January 11, 2022**
2+
3+
4+
**Version 1.1.1 - Released January 11, 2022**
5+
6+
* Added AppRole authentication support
7+
* Fixed miscellaneous JSON and documentation issues

‎release_notes/release_notes.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
<b>Hashicorp Vault Release Notes - Published by Splunk Community December 14, 2020</b>
1+
<b>Hashicorp Vault Release Notes - Published by Splunk Community January 11, 2022</b>
22
<br><br>
3+
<b>Version 1.1.1 - Released January 11, 2022</b>
4+
<ul>
5+
<li>Added AppRole authentication support</li>
6+
<li>Fixed miscellaneous JSON and documentation issues</li>
7+
</ul>
38
<b>Version 1.0.0 - Released December 14, 2020</b>
49
<ul>
510
<li>Initial Release</li>

‎release_notes/unreleased.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
**Unreleased**
2-
* Added AppRole authentication support
3-
* Fixed miscellaneous JSON and documentation issues

0 commit comments

Comments
 (0)