Skip to content

Commit

Permalink
Update CHANGELOG and module description for new version
Browse files Browse the repository at this point in the history
* Fix PowerShell help for newest platyPS version
* Fix some wording in README
  • Loading branch information
Karneades committed May 19, 2018
1 parent 4aee039 commit aba819e
Show file tree
Hide file tree
Showing 36 changed files with 257 additions and 247 deletions.
25 changes: 18 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,24 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased](https://github.com/swisscom/powergrr/compare/v0.8.0...master)
## [Unreleased](https://github.com/swisscom/powergrr/compare/v0.9.0...master)
<!--
### Added
### Changed
### Fixed
### Deprecated
### Removed
### Security
-->

## [v0.9.0](https://github.com/swisscom/powergrr/compare/v0.8.0...v0.9.0) - 2018-05-19

**Improve password handling** by allowing to **set the `$GRRCredential` variable
with the credential in the console** which is then used by all subsequent command
calls. The use of `-Credential` is therefore not needed anymore. For **better
converting the unix timestamp**, the function `ConvertFrom-EpocTime` was
added. Additionally, **improve PowerShell help**.

### Added
* Add functionality to read credentials from
environment (`$GRRCredential`) if available instead of prompting the user
Expand All @@ -19,12 +36,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
and export the function. Use `ConvertFrom-EpocTime` to convert unix
timestamps to UTC, e.g. in a registry flow, convert the st_mtime value
within PowerShell.
<!--
### Fixed
### Deprecated
### Removed
### Security
-->

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

Expand Down
2 changes: 1 addition & 1 deletion PowerGRR.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
RootModule = 'PowerGRR.psm1'

# Version number of this module.
ModuleVersion = '0.8.0'
ModuleVersion = '0.9.0'

# ID used to uniquely identify this module
GUID = '5bdf023f-fe8a-4748-bd73-43a449791ba8'
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Please see [Command Documentation](docs/PowerGRR.md), [Wiki](https://github.com/

***
<!-- vim-markdown-toc GFM -->

* [What is PowerGRR?](#what-is-powergrr)
* [Requirements](#requirements)
* [GRR server](#grr-server)
Expand Down Expand Up @@ -86,9 +87,7 @@ for the available flow types.

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

### PowerShell

Expand Down
8 changes: 4 additions & 4 deletions docs/Add-GRRArtifact.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
external help file: PowerGRR-help.xml
Module Name: PowerGRR
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Add-GRRArtifact.md
schema: 2.0.0
---
Expand Down Expand Up @@ -46,7 +47,7 @@ Path to artifact file.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 0
Expand Down Expand Up @@ -76,7 +77,7 @@ GRR credentials to use.
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 1
Expand All @@ -91,7 +92,7 @@ Return plain JSON instead of parsed JSON object.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Benannt
Expand Down Expand Up @@ -130,4 +131,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
6 changes: 3 additions & 3 deletions docs/ConvertFrom-Base64.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
external help file: PowerGRR-help.xml
Module Name: PowerGRR
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/ConvertFrom-Base64.md
schema: 2.0.0
---
Expand Down Expand Up @@ -56,7 +57,7 @@ Base64 encoded string to decode.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: True
Position: 0
Expand All @@ -71,7 +72,7 @@ Encoding to use. Unicode or UTF8.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -94,4 +95,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
4 changes: 2 additions & 2 deletions docs/ConvertFrom-EpocTime.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
external help file: PowerGRR-help.xml
Module Name: PowerGRR
online version: https://github.com/swisscom/powergrr/blob/master/docs/ConvertFrom-EpocTime.md
schema: 2.0.0
---
Expand Down Expand Up @@ -41,7 +42,7 @@ Unix timestamp to convert.
```yaml
Type: Int64[]
Parameter Sets: (All)
Aliases:
Aliases:

Required: True
Position: 0
Expand All @@ -64,4 +65,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
6 changes: 3 additions & 3 deletions docs/ConvertTo-Base64.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
external help file: PowerGRR-help.xml
Module Name: PowerGRR
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/ConvertTo-Base64.md
schema: 2.0.0
---
Expand Down Expand Up @@ -40,7 +41,7 @@ Encoding type - use `[Text.Encoding]::...` to specify the encoding.
```yaml
Type: Encoding
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 1
Expand All @@ -55,7 +56,7 @@ String to convert to base64.
```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Aliases:

Required: True
Position: 0
Expand All @@ -78,4 +79,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
10 changes: 5 additions & 5 deletions docs/Find-GRRClient.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
external help file: PowerGRR-help.xml
Module Name: PowerGRR
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Find-GRRClient.md
schema: 2.0.0
---
Expand Down Expand Up @@ -63,7 +64,7 @@ GRR credentials.
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 1
Expand All @@ -78,7 +79,7 @@ Show only the computername.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Benannt
Expand All @@ -93,7 +94,7 @@ Search string with the needed prefix, e.g. label: or host:...
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 0
Expand All @@ -108,7 +109,7 @@ Show the response as JSON instead of parsed object.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -131,4 +132,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
10 changes: 5 additions & 5 deletions docs/Find-GRRClientByLabel.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
external help file: PowerGRR-help.xml
Module Name: PowerGRR
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Find-GRRClientByLabel.md
schema: 2.0.0
---
Expand Down Expand Up @@ -43,7 +44,7 @@ GRR credentials.
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 1
Expand All @@ -58,7 +59,7 @@ Show only the computername.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Benannt
Expand All @@ -73,7 +74,7 @@ Label to search for.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 0
Expand All @@ -88,7 +89,7 @@ Return plain JSON instead of parsed JSON object.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -111,4 +112,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
6 changes: 3 additions & 3 deletions docs/Get-GRRArtifact.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
external help file: PowerGRR-help.xml
Module Name: PowerGRR
online version: https://github.com/swisscom/PowerGRR/blob/master/docs/Get-GRRArtifact.md
schema: 2.0.0
---
Expand Down Expand Up @@ -78,7 +79,7 @@ GRR credentials.
```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: 0
Expand All @@ -93,7 +94,7 @@ Return only plain JSON instead of converted JSON objects.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Benannt
Expand All @@ -116,4 +117,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
## RELATED LINKS
Loading

0 comments on commit aba819e

Please sign in to comment.