Skip to content

Commit

Permalink
Update readme (#22)
Browse files Browse the repository at this point in the history
* Update readme

* added linux install instructions

* update documentation

* fixed typo
  • Loading branch information
johnsarie27 committed Apr 15, 2024
1 parent 3f54471 commit c098601
Show file tree
Hide file tree
Showing 15 changed files with 1,357 additions and 1,334 deletions.
2 changes: 1 addition & 1 deletion Build/depend.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
PlatyPS = '0.14.2'
psake = '4.9.0'
#PSDeploy = '1.0.5'
PSScriptAnalyzer = '1.21.0'
PSScriptAnalyzer = '1.22.0'
}
134 changes: 67 additions & 67 deletions Documentation/ConvertFrom-PKCS7.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,67 @@
# ConvertFrom-PKCS7

## SYNOPSIS
Convert PKCS7 formatted certificate

## SYNTAX

```
ConvertFrom-PKCS7 [-Path] <String> [[-OutputDirectory] <String>] [<CommonParameters>]
```

## DESCRIPTION
Convert PKCS7 formatted certificate to non-PKCS7 format

## EXAMPLES

### EXAMPLE 1
```
ConvertFrom-PKCS7 -Path .\myCert.cer -OutputDirectory .\newFolder
Converts a PKCS7 formatted certificate to non-PKCS7 format with .crt extension
```

## PARAMETERS

### -Path
Path to PKCS7 formatted certificate file

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OutputDirectory
Output directory path

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: "$HOME\Desktop"
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None.
## OUTPUTS

### None.
## NOTES
General notes

## RELATED LINKS
# ConvertFrom-PKCS7

## SYNOPSIS
Convert PKCS7 formatted certificate

## SYNTAX

```
ConvertFrom-PKCS7 [-Path] <String> [[-OutputDirectory] <String>] [<CommonParameters>]
```

## DESCRIPTION
Convert PKCS7 formatted certificate to non-PKCS7 format

## EXAMPLES

### EXAMPLE 1
```
ConvertFrom-PKCS7 -Path .\myCert.cer -OutputDirectory .\newFolder
Converts a PKCS7 formatted certificate to non-PKCS7 format with .crt extension
```

## PARAMETERS

### -Path
Path to PKCS7 formatted certificate file

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OutputDirectory
Output directory path

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: "$HOME\Desktop"
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None.
## OUTPUTS

### None.
## NOTES
General notes

## RELATED LINKS
164 changes: 82 additions & 82 deletions Documentation/ConvertTo-PEM.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,82 @@
# ConvertTo-PEM

## SYNOPSIS
Convert PFX/P12 file to PEM file

## SYNTAX

```
ConvertTo-PEM [-PFX] <String> [[-OutputDirectory] <String>] [-Password] <SecureString> [<CommonParameters>]
```

## DESCRIPTION
Convert PFX/P12 file to PEM file including private key

## EXAMPLES

### EXAMPLE 1
```
ConvertTo-PEM -PFX .\myCert.pfx -OutputDirectory .\newFolder -Password $pw
Converts myCert.pfx to myCert.pem exposing all certificate details in plain text
```

## PARAMETERS

### -PFX
Path to PFX file

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OutputDirectory
Path to plain text output directory

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: "$HOME\Desktop"
Accept pipeline input: False
Accept wildcard characters: False
```

### -Password
Password to PFX file

```yaml
Type: SecureString
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None.
## OUTPUTS

### None.
## NOTES
General notes

## RELATED LINKS
# ConvertTo-PEM

## SYNOPSIS
Convert PFX/P12 file to PEM file

## SYNTAX

```
ConvertTo-PEM [-PFX] <String> [[-OutputDirectory] <String>] [-Password] <SecureString> [<CommonParameters>]
```

## DESCRIPTION
Convert PFX/P12 file to PEM file including private key

## EXAMPLES

### EXAMPLE 1
```
ConvertTo-PEM -PFX .\myCert.pfx -OutputDirectory .\newFolder -Password $pw
Converts myCert.pfx to myCert.pem exposing all certificate details in plain text
```

## PARAMETERS

### -PFX
Path to PFX file

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OutputDirectory
Path to plain text output directory

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: "$HOME\Desktop"
Accept pipeline input: False
Accept wildcard characters: False
```

### -Password
Password to PFX file

```yaml
Type: SecureString
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None.
## OUTPUTS

### None.
## NOTES
General notes

## RELATED LINKS
Loading

0 comments on commit c098601

Please sign in to comment.