Skip to content

Commit aba819e

Browse files
committed
Update CHANGELOG and module description for new version
* Fix PowerShell help for newest platyPS version * Fix some wording in README
1 parent 4aee039 commit aba819e

36 files changed

+257
-247
lines changed

CHANGELOG.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,24 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/)
55
and this project adheres to [Semantic Versioning](http://semver.org/).
66

7-
## [Unreleased](https://github.com/swisscom/powergrr/compare/v0.8.0...master)
7+
## [Unreleased](https://github.com/swisscom/powergrr/compare/v0.9.0...master)
8+
<!--
9+
### Added
10+
### Changed
11+
### Fixed
12+
### Deprecated
13+
### Removed
14+
### Security
15+
-->
16+
17+
## [v0.9.0](https://github.com/swisscom/powergrr/compare/v0.8.0...v0.9.0) - 2018-05-19
18+
19+
**Improve password handling** by allowing to **set the `$GRRCredential` variable
20+
with the credential in the console** which is then used by all subsequent command
21+
calls. The use of `-Credential` is therefore not needed anymore. For **better
22+
converting the unix timestamp**, the function `ConvertFrom-EpocTime` was
23+
added. Additionally, **improve PowerShell help**.
24+
825
### Added
926
* Add functionality to read credentials from
1027
environment (`$GRRCredential`) if available instead of prompting the user
@@ -19,12 +36,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1936
and export the function. Use `ConvertFrom-EpocTime` to convert unix
2037
timestamps to UTC, e.g. in a registry flow, convert the st_mtime value
2138
within PowerShell.
22-
<!--
23-
### Fixed
24-
### Deprecated
25-
### Removed
26-
### Security
27-
-->
2839

2940
## [v0.8.0](https://github.com/swisscom/powergrr/compare/v0.7.0...v0.8.0) - 2018-02-21
3041

PowerGRR.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
RootModule = 'PowerGRR.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '0.8.0'
15+
ModuleVersion = '0.9.0'
1616

1717
# ID used to uniquely identify this module
1818
GUID = '5bdf023f-fe8a-4748-bd73-43a449791ba8'

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Please see [Command Documentation](docs/PowerGRR.md), [Wiki](https://github.com/
99

1010
***
1111
<!-- vim-markdown-toc GFM -->
12+
1213
* [What is PowerGRR?](#what-is-powergrr)
1314
* [Requirements](#requirements)
1415
* [GRR server](#grr-server)
@@ -86,9 +87,7 @@ for the available flow types.
8687

8788
To be able to use all PowerGRR commands, one must use the current version of GRR.
8889
Some API calls, like starting a hunt or uploading or removing an artifact, are only
89-
working with current versions of GRR and not with the latest release (3.1.0.2).
90-
However, most API calls were already available in 3.1.0.2 and thus are working
91-
with PowerGRR too.
90+
working with current versions of GRR and not with the previous versions.
9291

9392
### PowerShell
9493

docs/Add-GRRArtifact.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: PowerGRR-help.xml
3+
Module Name: PowerGRR
34
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Add-GRRArtifact.md
45
schema: 2.0.0
56
---
@@ -46,7 +47,7 @@ Path to artifact file.
4647
```yaml
4748
Type: String
4849
Parameter Sets: (All)
49-
Aliases:
50+
Aliases:
5051

5152
Required: False
5253
Position: 0
@@ -76,7 +77,7 @@ GRR credentials to use.
7677
```yaml
7778
Type: PSCredential
7879
Parameter Sets: (All)
79-
Aliases:
80+
Aliases:
8081

8182
Required: False
8283
Position: 1
@@ -91,7 +92,7 @@ Return plain JSON instead of parsed JSON object.
9192
```yaml
9293
Type: SwitchParameter
9394
Parameter Sets: (All)
94-
Aliases:
95+
Aliases:
9596

9697
Required: False
9798
Position: Benannt
@@ -130,4 +131,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
130131
## NOTES
131132
132133
## RELATED LINKS
133-

docs/ConvertFrom-Base64.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: PowerGRR-help.xml
3+
Module Name: PowerGRR
34
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/ConvertFrom-Base64.md
45
schema: 2.0.0
56
---
@@ -56,7 +57,7 @@ Base64 encoded string to decode.
5657
```yaml
5758
Type: String
5859
Parameter Sets: (All)
59-
Aliases:
60+
Aliases:
6061

6162
Required: True
6263
Position: 0
@@ -71,7 +72,7 @@ Encoding to use. Unicode or UTF8.
7172
```yaml
7273
Type: String
7374
Parameter Sets: (All)
74-
Aliases:
75+
Aliases:
7576

7677
Required: False
7778
Position: Named
@@ -94,4 +95,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9495
## NOTES
9596
9697
## RELATED LINKS
97-

docs/ConvertFrom-EpocTime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: PowerGRR-help.xml
3+
Module Name: PowerGRR
34
online version: https://github.com/swisscom/powergrr/blob/master/docs/ConvertFrom-EpocTime.md
45
schema: 2.0.0
56
---
@@ -41,7 +42,7 @@ Unix timestamp to convert.
4142
```yaml
4243
Type: Int64[]
4344
Parameter Sets: (All)
44-
Aliases:
45+
Aliases:
4546

4647
Required: True
4748
Position: 0
@@ -64,4 +65,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6465
## NOTES
6566
6667
## RELATED LINKS
67-

docs/ConvertTo-Base64.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: PowerGRR-help.xml
3+
Module Name: PowerGRR
34
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/ConvertTo-Base64.md
45
schema: 2.0.0
56
---
@@ -40,7 +41,7 @@ Encoding type - use `[Text.Encoding]::...` to specify the encoding.
4041
```yaml
4142
Type: Encoding
4243
Parameter Sets: (All)
43-
Aliases:
44+
Aliases:
4445

4546
Required: False
4647
Position: 1
@@ -55,7 +56,7 @@ String to convert to base64.
5556
```yaml
5657
Type: String[]
5758
Parameter Sets: (All)
58-
Aliases:
59+
Aliases:
5960

6061
Required: True
6162
Position: 0
@@ -78,4 +79,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7879
## NOTES
7980
8081
## RELATED LINKS
81-

docs/Find-GRRClient.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: PowerGRR-help.xml
3+
Module Name: PowerGRR
34
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Find-GRRClient.md
45
schema: 2.0.0
56
---
@@ -63,7 +64,7 @@ GRR credentials.
6364
```yaml
6465
Type: PSCredential
6566
Parameter Sets: (All)
66-
Aliases:
67+
Aliases:
6768

6869
Required: False
6970
Position: 1
@@ -78,7 +79,7 @@ Show only the computername.
7879
```yaml
7980
Type: SwitchParameter
8081
Parameter Sets: (All)
81-
Aliases:
82+
Aliases:
8283

8384
Required: False
8485
Position: Benannt
@@ -93,7 +94,7 @@ Search string with the needed prefix, e.g. label: or host:...
9394
```yaml
9495
Type: String
9596
Parameter Sets: (All)
96-
Aliases:
97+
Aliases:
9798

9899
Required: False
99100
Position: 0
@@ -108,7 +109,7 @@ Show the response as JSON instead of parsed object.
108109
```yaml
109110
Type: SwitchParameter
110111
Parameter Sets: (All)
111-
Aliases:
112+
Aliases:
112113

113114
Required: False
114115
Position: Named
@@ -131,4 +132,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
131132
## NOTES
132133
133134
## RELATED LINKS
134-

docs/Find-GRRClientByLabel.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: PowerGRR-help.xml
3+
Module Name: PowerGRR
34
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Find-GRRClientByLabel.md
45
schema: 2.0.0
56
---
@@ -43,7 +44,7 @@ GRR credentials.
4344
```yaml
4445
Type: PSCredential
4546
Parameter Sets: (All)
46-
Aliases:
47+
Aliases:
4748

4849
Required: False
4950
Position: 1
@@ -58,7 +59,7 @@ Show only the computername.
5859
```yaml
5960
Type: SwitchParameter
6061
Parameter Sets: (All)
61-
Aliases:
62+
Aliases:
6263

6364
Required: False
6465
Position: Benannt
@@ -73,7 +74,7 @@ Label to search for.
7374
```yaml
7475
Type: String
7576
Parameter Sets: (All)
76-
Aliases:
77+
Aliases:
7778

7879
Required: False
7980
Position: 0
@@ -88,7 +89,7 @@ Return plain JSON instead of parsed JSON object.
8889
```yaml
8990
Type: SwitchParameter
9091
Parameter Sets: (All)
91-
Aliases:
92+
Aliases:
9293

9394
Required: False
9495
Position: Named
@@ -111,4 +112,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
111112
## NOTES
112113
113114
## RELATED LINKS
114-

docs/Get-GRRArtifact.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: PowerGRR-help.xml
3+
Module Name: PowerGRR
34
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Get-GRRArtifact.md
45
schema: 2.0.0
56
---
@@ -78,7 +79,7 @@ GRR credentials.
7879
```yaml
7980
Type: PSCredential
8081
Parameter Sets: (All)
81-
Aliases:
82+
Aliases:
8283

8384
Required: False
8485
Position: 0
@@ -93,7 +94,7 @@ Return only plain JSON instead of converted JSON objects.
9394
```yaml
9495
Type: SwitchParameter
9596
Parameter Sets: (All)
96-
Aliases:
97+
Aliases:
9798

9899
Required: False
99100
Position: Benannt
@@ -116,4 +117,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
116117
## NOTES
117118
118119
## RELATED LINKS
119-

0 commit comments

Comments
 (0)