Skip to content

Latest commit

 

History

History
91 lines (71 loc) · 2.48 KB

ConvertTo-MRNGSecureString.md

File metadata and controls

91 lines (71 loc) · 2.48 KB

ConvertTo-MRNGSecureString

SYNOPSIS

Convert a plain text string to a mRemoteNG secure string.

SYNTAX

ConvertTo-MRNGSecureString [-Message] <String> [[-EncryptionKey] <SecureString>] [[-EncryptionEngine] <String>] [[-BlockCipherMode] <String>] [[-KeyDerivationIterations] <Int32>] [<CommonParameters>]

DESCRIPTION

PARAMETERS

-Message <String>

The string to be converted.

Required?                    true
Position?                    1
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-EncryptionKey <SecureString>

The encryption key to use when encrypting the string. It should match what you are using in your ConfCons.xml file. If no password is supplied the default mRemoteNG encryption key is "mR3m".

Required?                    false
Position?                    2
Default value                ( ConvertTo-SecureString -String 'mR3m' -AsPlainText -Force )
Accept pipeline input?       false
Accept wildcard characters?  false

-EncryptionEngine <String>

The encryption engine to use when encrypting the string. Choices are 'AES', 'Serpent', and 'Twofish'. The default is 'AES'.

Required?                    false
Position?                    3
Default value                AES
Accept pipeline input?       false
Accept wildcard characters?  false

-BlockCipherMode <String>

The block cipher mode to use when encrypting the string. Choices are 'GCM', 'CCM', and 'EAX'. The default is 'GCM'.

Required?                    false
Position?                    4
Default value                GCM
Accept pipeline input?       false
Accept wildcard characters?  false

-KeyDerivationIterations <Int32>

The number of key derivation iterations to perform when encrypting the string. Valid values are in the range 1,000 to 50,000.

Required?                    false
Position?                    5
Default value                1000
Accept pipeline input?       false
Accept wildcard characters?  false

INPUTS

OUTPUTS

System.String

NOTES

EXAMPLES

EXAMPLE 1

PS C:\>ConvertTo-MRNGSecureString -Message 'SecureP@ssword!'

EXAMPLE 2

PS C:\>ConvertTo-MRNGSecureString -Message 'SecureP@ssword!' -EncryptionEngine Serpent -BlockCipherMode EAX

EXAMPLE 3

PS C:\>ConvertTo-MRNGSecureString -Message 'SecureP@ssword!' -EncryptionKey ( 'password' | ConvertTo-SecureString -AsPlainText -Force )