ConvertFrom-SecureString

  • リファレンス
モジュール:
Microsoft.PowerShell.Security

セキュリティで保護された文字列を暗号化された標準文字列に変換します。

構文

ConvertFrom-SecureString
                [-SecureString] <SecureString>
                [[-SecureKey] <SecureString>]
                [<CommonParameters>]
ConvertFrom-SecureString
                [-SecureString] <SecureString>
                [-AsPlainText]
                [<CommonParameters>]
ConvertFrom-SecureString
                [-SecureString] <SecureString>
                [-Key <Byte[]>]
                [<CommonParameters>]

説明

このコマンドレットは ConvertFrom-SecureString 、セキュリティで保護された文字列 (System.Security.SecureString) を暗号化された標準文字列 (System.String) に変換します。 セキュリティで保護された文字列とは異なり、暗号化された標準文字列は、ファイルに保存して後で使用することができます。 暗号化された標準文字列は、コマンドレットを使用して、セキュリティで保護された文字列形式に ConvertTo-SecureString 戻すことができます。

Key パラメーターまたは SecureKey パラメーターを使用して暗号化キーが指定されている場合は、Advanced Encryption Standard (AES) 暗号化アルゴリズムが使用されます。 指定するキーの長さは、AES 暗号化アルゴリズムによってサポートされている 128、192、または 256 ビットにする必要があります。 キーを指定しない場合には、Windows データ保護 API (DPAPI) が使用されて標準文字列の表現が暗号化されます。

Note

DotNet ごとに、SecureString の内容は Windows 以外のシステムでは暗号化されないことに注意してください。

例

例 1: セキュリティで保護された文字列を作成する

$SecureString = Read-Host -AsSecureString

このコマンドは、コマンド プロンプトで入力した文字からセキュリティで保護された文字列を作成します。 コマンドを入力した後で、セキュリティで保護された文字列として格納する文字列を入力します。 入力した各文字を表すアスタリスク (*) が表示されます。

例 2: セキュリティで保護された文字列を暗号化された標準文字列に変換する

$StandardString = ConvertFrom-SecureString $SecureString

このコマンドは、変数内のセキュリティで保護された文字列を $SecureString 暗号化された標準文字列に変換します。 結果として得られる暗号化された標準文字列は、変数に $StandardString 格納されます。

例 3: 192 ビット キーを使用して、セキュリティで保護された文字列を暗号化された標準文字列に変換する

$Key = (3,4,2,3,56,34,254,222,1,1,2,23,42,54,33,233,1,34,2,7,6,5,35,43)
$StandardString = ConvertFrom-SecureString $SecureString -Key $Key

これらのコマンドでは、Advanced Encryption Standard (AES) アルゴリズムを使用して、変数に格納されているセキュリティで $SecureString 保護された文字列を、192 ビット キーを持つ暗号化された標準文字列に変換します。 結果として得られる暗号化された標準文字列は、変数に $StandardString 格納されます。

最初のコマンドは、変数にキーを $Key 格納します。 キーは 24 桁の 10 進数の配列で、1 つの符号なしバイト内に収まるには、それぞれ 256 未満である必要があります。

各 10 進数は 1 バイト (8 ビット) を表しているため、キーには合計 192 ビット (8 x 24) の 24 桁の数字があります。 これは、AES アルゴリズムの有効なキー長さです。

2 番目のコマンドでは、変数のキーを $Key 使用して、セキュリティで保護された文字列を暗号化された標準文字列に変換します。

例 4: セキュリティで保護された文字列をプレーンテキスト文字列に直接変換する

$secureString = ConvertTo-SecureString -String 'Example' -AsPlainText
$secureString # 'System.Security.SecureString'
ConvertFrom-SecureString -SecureString $secureString -AsPlainText # 'Example'

パラメーター

-AsPlainText

設定すると、 ConvertFrom-SecureString セキュリティで保護された文字列が暗号化解除されたプレーンテキスト文字列に出力として変換されます。

このパラメーターは PowerShell 7.0 で追加されました。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Key

暗号化キーを、バイト配列として指定します。

Type:Byte[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SecureKey

暗号化キーを、セキュリティで保護された文字列として指定します。 セキュリティで保護された文字列値は、キーとして使用される前に、バイト配列に変換されます。

Type:SecureString
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SecureString

暗号化された標準文字列に変換するセキュリティで保護された文字列を指定します。

Type:SecureString
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

SecureString

SecureString オブジェクトをこのコマンドレットにパイプできます。

出力

String

このコマンドレットは、作成されたプレーンテキスト文字列を返します。

メモ

  • コマンド プロンプトで入力された文字からセキュリティで保護された文字列を作成するには、コマンドレットの AsSecureString パラメーターを Read-Host 使用します。
  • キーまたは SecureKey パラメーターを使用してキーを指定する場合は、キーの長さが正しい必要があります。 たとえば、128 ビットのキーは、16 桁の 10 進数のバイト配列として指定できます。 同様に、192 ビットおよび 256 ビットのキーは、それぞれ 24 桁と 32 桁の 10 進数のバイト配列に対応します。
  • 絵文字などの一部の文字は、それらを含む文字列内のいくつかのコード ポイントに対応します。 これらの文字は、パスワードで使用すると問題や誤解を引き起こす可能性があるため、使用しないでください。