いろいろ備忘録日記

主に .NET とか Go とか Flutter とか Python絡みのメモを公開しています。

.NET クラスライブラリ探訪-027 (System.Security.SecureString)(文字列, 暗号化, MakeReadOnly, Marshal, SecureStringToCoTaskMemUnicode, ZeroFreeCoTaskMemUnicode)

C#


System.Security.SecureStringは文字とおりセキュアな文字列を表します。
ほとんどのケースで文字列はstringが利用されますが、パスワードなどの
機密情報を扱ったりする際に、このクラスを利用したりします。


一番よくみかけるのがProcessクラスのStartメソッドでしょうか。
このメソッドにはパスワードを渡すことが出来るオーバーロードが
存在し、SecureStringを渡す仕様となっています。


SecureStringに設定されたデータは自動的に暗号化され、GCの対象となります。
（逆に、通常のstringオブジェクトは暗号化されずGCのスケジュール対象となりません。）
SecureStringにはデータを設定するメソッドは存在しますが、データを取り出したり、見たりする
メソッドは存在しません。設定したデータを復元するには、後述するサンプルにあるように
Marshalクラスを利用して取得します。


値を追加するには以下のメソッドを利用します。

  • AppendChar
  • InsertAt
  • SetAt


値を削除するには以下のメソッドを利用します。

  • RemoveAt


MakeReadOnlyメソッドを呼ぶと、読み取り専用となり、それ以降の変更が行えなくなります。
読み取り専用にするまでは、データを変更可能です。


データを復元するには、Marshalクラスの以下のメソッドを利用します。

  • Marshal.SecureStringToCoTaskMemUnicode
  • Marshal.Copy
  • Marshal.ZeroFreeCoTaskMemUnicode


ポインタを扱うので、必ずfinallyにてZeroFreeCoTaskMemUnicodeを呼ぶ必要があります。


以下、サンプルです。

#region SecureStringSamples-001
    public class SecureStringSamples001 : IExecutable
    {
        public void Execute()
        {
            //
            // SecureStringのサンプル.
            //
            // System.Security.SecureStringクラスは、通常の文字列とは
            // 違い、パスワードなどの機密情報を扱ったりする際に利用される。
            //
            // よく利用されるProcessクラスのStartメソッドではパスワードを渡す際は
            // SecureStringを渡す必要がある。
            //
            // このクラスのインスタンスに設定された内容は自動的に暗号化され
            // MakeReadOnlyメソッドを利用して、読み取り専用とすると変更できなくなる。
            //
            // SecureStringにデータを設定する際は、AppendCharメソッドを利用して
            // 1文字ずつデータを設定していく必要がある。
            //
            // SecureStringには、値を比較または変換する為のメソッドが存在しない。
            // 操作を行う為には、System.Runtime.InteropServices.MarshalのCoTaskMemUnicodeメソッドと
            // Copyメソッドを利用してchar[]に変換する必要がある。
            //

            //
            // SecureStringを構築.
            //
            // 実際はユーザからのパスワード入力を元にSecureStringを構築したりする.
            //
            SecureString secureStr = MakeSecureString();

            //
            // ToString()メソッドを呼び出してもSecureStringの中身を
            // 見ることはできない。
            //
            Console.WriteLine(secureStr);

            //
            // IsReadOnlyメソッドで現在読み取り専用としてマークされているか否かが
            // 判別できる。読み取り専用でない場合、変更は可能。
            //
            // 読み取り専用にするにはMakeReadOnlyメソッドを使用する。
            //
            Console.WriteLine("IsReadOnly:{0}", secureStr.IsReadOnly());
            secureStr.MakeReadOnly();
            Console.WriteLine("IsReadOnly:{0}", secureStr.IsReadOnly());

            //
            // SecureStringの中身を復元するには、以下のメソッドを利用する。
            //
            // ■Marshal.SecureStringToCoTaskMemUnicodeメソッド
            // ■Marshal.Copyメソッド
            // ■Marshal.ZeroFreeCoTaskMemUnicodeメソッド
            //
            RestoreSecureString(secureStr);
        }

        SecureString MakeSecureString()
        {
            SecureString secureStr = new SecureString();

            foreach(char ch in "hello world")
            {
                secureStr.AppendChar(ch);
            }

            return secureStr;
        }

        void RestoreSecureString(SecureString secureStr)
        {

            IntPtr pointer = IntPtr.Zero;
            try
            {
                //
                // コピー先のバッファを作成.
                //
                char[] buffer = new char[secureStr.Length];

                //
                // 復元処理.
                //
                pointer = Marshal.SecureStringToCoTaskMemUnicode(secureStr);
                Marshal.Copy(pointer, buffer, 0, buffer.Length);

                Console.WriteLine(new string(buffer));
            }
            finally
            {
                if (pointer != IntPtr.Zero)
                {
                    //
                    // 解放.
                    //
                    Marshal.ZeroFreeCoTaskMemUnicode(pointer);
                }
            }
        }
    }
#endregion

＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝
過去の記事については、以下のページからご参照下さい。

サンプルコードは、以下の場所で公開しています。