【Oracle】DBMS_CRYPTOパッケージを用いてデータを暗号化する

TL;DR

  • OracleDBMS_CRYPTOという暗号化関数がまとまった標準パッケージがある。
  • 引数のデータ型はRAW型(デフォルトで最大2000bytes、設定変更で32757bytes)。CHAR/VARCHAR型との変換はUTL_I18Nパッケージを用いる。
  • 暗号化関数DBMS_CRYPTO.ENCRYPT関数 / 復号化DBMS_CRYPTO.DECRYPT関数は非DETERMINISTICなので直接関数インデックスに用いることはできない。ストアドファンクションでラップする必要がある。
  • 暗号化 / 復号化キーを隠匿するのはできるが各方面満点の解はない

前提

  • Oracle19c

DBMS_CRYPTOパッケージ

公式ドキュメント

docs.oracle.com

利用の前提条件

  • Oracle19c現在、追加ライセンス不要。
  • 初期では権限不足でどのユーザーも使えないため、権限付与SQLの実行要(たぶんsysユーザーが必要)
-- 権限付与
GRANT execute ON SYS.DBMS_CRYPTO TO youruser;

利用例

使い方例(暗号化)

-- 暗号化
SELECT
 DBMS_CRYPTO.ENCRYPT(
    UTL_I18N.STRING_TO_RAW('暗号化対象データ', 'AL32UTF8'),
    6+256+4096,  -- 暗号化指定。このパラメータはAES128
    HEXTORAW('010203040506070809a0b0c0d0e0f000') -- 暗号化キー
  )
  AS crypt
FROM
  dual;

result

CRYPT
--------------------------------------------------------------------------------
2F5C489FB4BE399A4EB81FFBA6B6E28645B7060B5EC1D93F63571A4E0F119C02
  • 第二引数の値は、DBMS_CRYPTOパッケージ配下の定数を参照。
    • URL:DBMS_CRYPTO
    • 例えば 6 + 256 + 4096 は、以下で確認できる
SET SERVEROUTPUT ON

BEGIN
   DBMS_OUTPUT.PUT_LINE(DBMS_CRYPTO.ENCRYPT_AES128);
   DBMS_OUTPUT.PUT_LINE(DBMS_CRYPTO.CHAIN_CBC);
   DBMS_OUTPUT.PUT_LINE(DBMS_CRYPTO.PAD_PKCS5);
END;
/

使い方例(復号化)

-- 復号化
SELECT
 UTL_I18N.RAW_TO_NCHAR(
   DBMS_CRYPTO.DECRYPT(
      crypt,
      6+256+4096,
      HEXTORAW('010203040506070809a0b0c0d0e0f000')
    )
  , 'AL32UTF8') as plain
FROM
  (SELECT
   DBMS_CRYPTO.ENCRYPT(
      UTL_I18N.STRING_TO_RAW('暗号化対象データ', 'AL32UTF8'),
      6+256+4096, 
      HEXTORAW('010203040506070809a0b0c0d0e0f000')
  ) AS crypt
  FROM
    dual
  );
  • 結果はRAW型なので RAW_TO_CHARRAW_TO_NCHAR で復号する必要あり
  • 暗号アルゴリズムによって、暗号キー・復号キーが異なる場合がある。(RSAなどが該当)

関数インデックス

  • 以下はエラーとなる。
CREATE TABLE sample(crypt RAW(2000));
CREATE INDEX idx_sample ON sample(DBMS_CRYPTO.DECRYPT(crypt, 0, HEXTORAW('00')));
CREATE INDEX idx_sample ON sample(DBMS_CRYPTO.DECRYPT(crypt, 0, HEXTORAW('00')))
                                  *
行1でエラーが発生しました。:
ORA-30553: 関数がDETERMINISTICではありません。
  • 以下のように、DETERMINISTICなストアドファンクションを定義することで回避できる。
CREATE OR REPLACE FUNCTION DECRYPT_AES128
  (
    -- 暗号データ
    src IN VARCHAR2,
    -- 復号キー。16bytesであること
    key IN VARCHAR2
  )
  RETURN RAW DETERMINISTIC
IS
BEGIN
  RETURN DBMS_CRYPTO.DECRYPT(
    UTL_I18N.STRING_TO_RAW(src, 'AL32UTF8'),
    DBMS_CRYPTO.ENCRYPT_AES128 +
    DBMS_CRYPTO.CHAIN_CBC +
    DBMS_CRYPTO.PAD_PKCS5,
    UTL_I18N.STRING_TO_RAW(key, 'AL32UTF8')
  );
END;
/
CREATE INDEX idx_sample ON sample(DECRYPT_AES128(crypt, 0, HEXTORAW('00')))
  • 後述するが、関数インデックスはデータファイル上暗号化されないので注意。

暗号化キーの隠匿化

  • SQLのパラメータとしてキー値を渡したりSQL文にベタ書きすると、Oracle内ログ、アプリログ、通信にキーが曝露するのでセキュリティ上非常によくない。
  • 色々方式はあるが、PL/SQL内にキーを隠匿し、SOURCEも隠匿する手法にいきついたので紹介

SOURCEを秘匿化しながらストアドファンクションを定義

DECLARE
   ddl_text VARCHAR2(32767);
   key_nchar VARCHAR2(32) := '010203040506070809a0b0c0d0e0f000';

   FUNCTION generaye_ENCRYPT_AES128_DDL RETURN VARCHAR2
   IS
   BEGIN
      return 'CREATE OR REPLACE FUNCTION ENCRYPT_AES128' ||
         '  (' ||
         '    src IN VARCHAR2' ||
         '  )' ||
         '  RETURN RAW DETERMINISTIC' ||
         ' IS' ||
         ' BEGIN' ||
         '  RETURN DBMS_CRYPTO.ENCRYPT(' ||
         '    UTL_I18N.STRING_TO_RAW(src, ''AL32UTF8''),' ||
         '    DBMS_CRYPTO.ENCRYPT_AES128 +' ||
         '    DBMS_CRYPTO.CHAIN_CBC +' ||
         '    DBMS_CRYPTO.PAD_PKCS5,' ||
         '    HEXTORAW('''|| key_nchar ||''')' ||
         '  );' ||
         'END;';
   END generaye_ENCRYPT_AES128_DDL;
   FUNCTION generaye_DECRYPT_AES128_DDL RETURN VARCHAR2
   IS
   BEGIN
      return 'CREATE OR REPLACE FUNCTION DECRYPT_AES128' ||
         '  (' ||
         '    src IN RAW' ||
         '  )' ||
         '  RETURN VARCHAR2 DETERMINISTIC' ||
         ' IS' ||
         ' BEGIN' ||
         '  RETURN UTL_I18N.RAW_TO_NCHAR(DBMS_CRYPTO.DECRYPT(' ||
         '    src,' ||
         '    DBMS_CRYPTO.ENCRYPT_AES128 +' ||
         '    DBMS_CRYPTO.CHAIN_CBC +' ||
         '    DBMS_CRYPTO.PAD_PKCS5,' ||
         '    HEXTORAW('''|| key_nchar ||''')' ||
         '  ), ''AL32UTF8'');' ||
         'END;';
   END generaye_DECRYPT_AES128_DDL;
BEGIN
   ddl_text := generaye_ENCRYPT_AES128_DDL();
   EXECUTE IMMEDIATE ddl_text;
   SYS.DBMS_DDL.CREATE_WRAPPED(ddl_text);
   ddl_text := generaye_DECRYPT_AES128_DDL();
   EXECUTE IMMEDIATE ddl_text;
   SYS.DBMS_DDL.CREATE_WRAPPED(ddl_text);
END;
/
  • デモ
select
 ENCRYPT_AES128('テストデータ') as crypt,
 DECRYPT_AES128(ENCRYPT_AES128('テストデータ')) as plain
from dual;
CRYPT
--------------------------------------------------------------------------------
PLAIN
--------------------------------------------------------------------------------
21E108C3DCA3AFFDAC709FB1079F71724C90C3EB22FC90E7D03EC066598568D8
テストデータ
  • 仕組みはよく分からないが、SYS.DBMS_DDL.CREATE_WRAPPED()を介すことでSOURCEが簡単に見れなくなる
  • Oracleのドキュメントを見ると動的に生成、とあるので、もしかしたらパフォーマンスに影響があるかもしれない(未検証)
SELECT text FROM ALL_SOURCE WHERE name = 'ENCRYPT_AES128';
FUNCTION ENCRYPT_AES128 wrapped
a000000
369
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
abcd
8
12a 128
rcNM2xfPeGeX3nLRY90YTcVHg+owg3nQDEgVZy+ix4kZiJlGlznTgNjUhvtgN2E96/8XKgYS
te98VEs30mFBh1xkI2H8uhvGK/l78NQCUdjjYInR42xy0nnbSF+Joq33V80CoUcoKtyQinr4
DiI3NyfE3M4d3vxM49YNkBmB1g2xedLplesOBkKkDfD63/IBtpdHnyszReXCz8ALtVJ6G0pP
TqCzx6ANEPB769u52UCVylVTD3kgjYieiXU4SkQZCDeeTxJ2uNu9F3GmkSnuzylTk7xM+2ha
DIA=

セキュリティ的な評価

脅威 評価 追加対策の余地
OSに不正ログインされ、Oracleのテーブルデータファイルを詐取される 〇:暗号化されており、復号キーも漏洩していない
OSに不正ログインされ、Oracleのインデックスデータファイルを詐取される ×:インデックス値は平文で保存されている Oracle Advanced Security(有料オプション)のTDEでデータファイルを暗号化する。問題のあるキーの組み合わせ(個人名, 電話番号の複合インデックスなど)を用いない、インデックス化を避けるなどの設計による対処
DBに不正ログインされ、SQLを実行される △:復号化関数や手法を知っていれば平文を漏洩してしまう 関数名の難読化、手掛かりにいきつくまでの妨害・ログの秘匿化
DBにログインした作業者による詐取 △:復号化関数や手法を知っていれば平文を漏洩してしまう 保守ユーザ/アプリユーザの分離・権限の制限
アプリケーション脆弱性によるSQLインジェクション経由での詐取 〇:復号化関数の存在を知ることは困難と考えられるため、暗号化したデータしか表示されない

TDEとの比較

  • TDEは、Oracle Advanced Security(有料オプション)の機能の1つ。
  • TDEは、Oracleのデータファイルを暗号化する。そのため、SQL実行による参照は保護されず、アプリケーションからのSQLインジェクションにも対応できない。
  • 情報のマスキングは、Oracle Advanced Securtyの他オプションでも可能だが、特定ユーザーはマスキング項目を非表示にするなどの作業者へのいじわると、暗号化による保護というよりは内部統制のソリューションであり、DBへの不正接続・SQLインジェクションなどによる任意クエリ実行の対策にはならないと考えている。
    • 詳しく調べてないので、有識者に聞いてみたい。

WindowsPC同士で有線LAN1本直結でリモートデスクトップ接続する

クロスケーブルを買って接続

ストレートケーブルとクロスケーブルを見分ける方法 | バッファロー

通常のLANケーブル(ストレートケーブル)に対して、 端子のピンの並びが端と端同士で鏡のように左右対称に なっているLANケーブルのこと。 PC同士の接続に使う。ルータやハブには使えない。

IPアドレスを手動で設定する

Windows 10でLANケーブルでPC同士を繋いでファイル共有 - キリウ君が読まないノート

WindowsPCを接続しただけでは、DHCP(自動でIPアドレスが 割り振られる仕組み)が働かない。 通常、ブロードバンドルータや企業ネットワークなどでは DHCPサーバーが担当。)

よくわからなければ、サイトの通りに設定すると間違いがない。

蛇足 プライベートIPアドレスとは

なお、元のLANに接続しなおして「IPアドレスが重複しています」 などのエラーが出たら、即時IPアドレスを自動設定に戻すようにする。 (大目玉くらいます)

リモートデスクトップで接続される側のWindowsリモートデスクトップを有効にする

PC でリモート デスクトップを有効にする | Microsoft Learn

リモートデスクトップで接続される側のWindowsの「パブリックネットワーク」のファイアウォールを切る

直接LANで接続している場合必ずパブリックネットワークになり、 デフォルトではファイル共有およびリモートデスクトップ接続が無効となる。 セキュリティソフトやWindowsファイアウォールの設定を見て、 パブリックネットワークの設定を変える。

Norton Intenet Security リモートデスクトップ許可設定 - KuroNeko666’s blog

リモートデスクトップのWindowsファイアウォール設定 | 日記というほどでも

以上

これで接続できなかったら、pingとかで地道に検証。

謎シチュに至った訳

初学者がUMLだけやっても意味がないのでは?

身も蓋もない言い方

設計は沼であり、大事な仕事・作業・人間生活にかかることであればちゃんと武装して臨むべき。

UMLは可視化ツール

クラスを中心としたソースコードを書けば、対応するUMLは半ば機械的に生成できる。 UMLは地図であって、極地的な地形であってもとりあえずそのままに書けてしまう。

良い設計は、コンセプトを伴ったパターンを持つことが一種指標に思える。 例えば、クラス図は汎化を表現できるが、以下のように指向するとよい設計につながる。

  • あるデスクトップアプリケーションのデータ書き込み処理は、同じデータを固定長レイアウト、JSON形式、CSV形式の3パターンで表現する。
  • 3パターンの形式を決定するのは、書き込み時にGUI指定する。それ以外のファイル書き込み時のハンドリングはすべて共通。
  • それぞれの派生クラスを「生成」し、後続のファイル書き込み処理に、書き込みデータ供給の共通インタフェースを通じて処理をさせる。

こう言葉で書くとながったらしいことを、UMLは記号化してくれる。 しかし、この複雑さを簡略化はしてくれず、説明を端折ると謎の図になる。

実装パターンを豊富に知っているのであれば、思いつくままパズルの要領でつなぎ合わせて6,7個ぐらいの概念を同時に入れたところで依存性の糸の絡まり具合を可視化し、ここは切れるとかこの概念は相性が悪そうだとかを診断するためのツールになる。

初学者にとってのUML

まだ学生の頃にカリキュラムとしてUMLを触れた当時は価値がわからなかった。 簡単なMVCモデルの1画面をクラス図に書いただけで整理の必要が全くなかったのが一番の原因だが、 複雑なものを表現したとしても、知見不足で書いてみたのでは結局わからずじまいだったかもしれない。

そもそも、UML関連の学習コンテンツは説明が悪いことが多い。 「集約とは、集めて持つことである」「包含とは内部にオブジェクトを隠ぺいして持つことである」「依存はそのクラスを使っていることである」 と定義はわかるのが、なんのために依存するとか、この構造を持つことで特定の処理時にパターン化できるとか、ケーススタディ的な学びがUMLと一緒にできる例についに出会うことはなかった。 「設計とかコーディングのときに気づき内省しものにせよ」と寿司職人さながらのマインドはまだしも、UMLは握ってモチベーションに駆られるかの観点から題材の悪さしか印象にない。

設計とUML

UMLは良くも悪くも可視化ツールだ。 なので、パターンとコンセプトのある設計を表現してみて確からしさを検証するための手遊びの道具であり、 実際の実装や他の図と反復しながら多角的に検証したり、豊富なナレッジベースを並べてみて組み合わせを評価するのが一番道具として生きると考えている。 もし、UMLがしっくりこないとか意味が解らないのであれば、少し仕事や勉強から逸れたことをして、思い切り複雑で新しいことをしたときにでも思い出して無理やり書いてみるとどうだろうか。

【ExcelVBA】VBAはクラス指向より手続き型でFATに作りたい

前置き

VBAでもクラスは作成できる。

qiita.com

しかし、フォルダや階層による小分けができない。 例えば設定ファイルの保持やパースのために作ったConfigクラス、特定ファイルの書き出しのために作ったExternalXXXCSVFileクラスやExternalYYYCSVFile、内部のファイルの保持のために作ったTempFileクラス、その他値の保持用だったりビジネスロジックがぐちゃぐちゃに入り組んだりする実態が同じフォルダに入る。 そこそこの規模のアプリを作ろうとしたとき、違う考え方の領域が10個ぐらい、系3,40個のクラスが並列に並ぶことになる。これはWeb系の言語でやっているようなスケーラブル(脳死で拡張可能)なオブジェクト指向なクラスの管理だろうか?

プロジェクト(=Excelブックやxlamファイル)で分ければできるが、全部読み込むようにするのは手間だし分割も面倒、本末転倒だ。

そこそこ小さい実装ならまあいい感じの実装にはなるだろう、しかし個人としては、VBAでクラス指向*1 で設計するのはアンチパターンと位置付けるに至った。

MVCは、1つの標準モジュール/Excelシート/シートVBAを1つの「M」「V」「C」に見立ててみる

Web系に馴染みのある方であればMVCパターンを適用したくなるだろう。 ここで、それぞれの要素をModel(処理の本体)、View(ユーザーインタフェース)、Contoller(MとVの繋ぎ)で考える。(※Web系実装のMVCは通常、Mはステートフル=DBやデータなどの状態を持ち更新処理などがあるが、ここでは基本的にステートレス=データ保持無しのため、実行時パラメータによって完全に決まるものとする。)

V。Excelシートそのもの。 C。Excelシートをクリックしたときに実行するハンドラ。色々な変換処理がある。Mを呼び出す。 M。Cの結果を受けて、何かしら外部ファイルを出力したり作用したりするメソッドのみの存在。単独テストが可能。

V → Cへの繋ぎは、ExcelのRangeやCellといった各種APIで代用となる。ここら辺が特にツライが、データ化すればこっちのもの。FormやDto、Entity、Recordといった実体が欲しいのであればCreateObject("Dictionary.Scripting")で連想配列を使ったり、そこだけクラスモジュール化してもよい。 C → Mへの繋ぎは、V→Cでデータ化したものをそのまま受け渡すだけでよい。

以上、やりたいことは、引数と戻り値だけの標準モジュールで実装できないだろうか。

モジュールとImmutableを基本に設計・実装する

ローカル変数以外に、メモリ中に状態を持たず、処理結果や確保したリソースを引き続き保持したければすべて引数・戻り値を介して取得・保持し、メンバー変数やグローバル変数は必要時以外排除すると、自然とImmutableな実装は達成される。 細かい項目の受け渡しが面倒であれば、そこだけクラス化や連想配列化によりまとめて処理してしまえばよい。ここまで徹底的にやれば、晴れてクラス実装を手放せる。

代わりに、1つのモジュールの責務が肥大化するが、Excel VBAはそもそもスコープが小さくなる傾向にあるので、よほどの場合を除きコントロール可能な範囲に収まるはず。(そもそも、VBAがコントロール不能なぐらい肥大化している場合、もはやExcel VBA以外の実装を用いたほうがメリットが大きいというような事態に陥ってないだろうか?)

*1:「クラス指向」の言い回しは、オブジェクト指向に造詣の深い方にとって違和感の塊だろう、しかしあえて揶揄している。多態を持たず、静的なプログラム構造によって実際の動作および俯瞰図が完成するのであれば、メモリ上に実態を展開し実行時情報を持つというオブジェクト指向の原典的な利点の1つは別になくても、クラスという書式でカプセル化、レイヤ化、関心や責任の分離は実現できる。そしてその3点はC言語のような純手続き型言語でも設計によって十分可能であり、現実に、1970年代に軍事系のC言語の開発プロジェクトで達成されたという研究もある。クラス名のパターンが設計のすべてなのであれば、関数名+引数にとる構造体のグループでほぼ誤差なく手続き型に落とせる。

【Excel VBA】ファイルの絶対パスを取得する

カレントディレクト

Sub 使いないやつ()
    Debug.Print CreateObject("Scripting.FileSystemObject").GetAbsolutePathName("./")
    Debug.Print CurDir
End Sub
  • どっちも、デフォルトだと%UsersProfile%\Documents(マイドキュメント)を指す。
  • Excelのワークブックのパス基準の絶対パス取得は以下の通り。
Public Function AbsPath(String RelativePath) As String
On Error GoTo HANDLING
    Dim DirBK As String
    DirBK = CurDir
    ChDrive Left(ThisWorkbook.Path, 1)
    ChDir ThisWorkbook.Path
    AbsPath = CreateObject("Scripting.FileSystemObject").GetAbsolutePathName(RelativePath)
    ChDrive Left(DirBK, 1)
    ChDir DirBK
    Exit Function
    
HANDLING:
    Debug.Log ("[ERROR]AbsPath():" & ERR.Description)
    ERR.Raise ERR.Number, ERR.Source, ERR.Description, ERR.HelpFile, ERR.HelpContext
    
End Function()
  • FileSystemObjectやChDirを使わないレシピ
Public Function AbsPath(Path As String) As String
On Error GoTo HANDLING

    If (InStr(Path, ":") <> 2) Then
        Path = ThisWorkbook.Path & "\" & Path
    Else
        Path = Path
    End If
    
    
    Dim idx As Long
    Do While InStr(Path, "..\") > 0
        idx = InStr(Path, "..\")
        
        Dim idxPrevSep As Long
        idxPrevSep = InStrRev(Path, "\", idx - 2)
        If (idxPrevSep = 0) Then
            Exit Do
        End If
        
        Path = Left(Path, idxPrevSep - 1) & Mid(Path, idx + 2)
    Loop
    
    Path = Replace(Path, ".\", "")
    AbsPath = Path
    
    Exit Function
    
HANDLING:
    Debug.Log ("[ERROR]AbsPath():" & ERR.Description)
    ERR.Raise ERR.Number, ERR.Source, ERR.Description, ERR.HelpFile, ERR.HelpContext
    
End Function

【Excel VBA】エラー処理(例外処理)をちゃんと書く

概要

  • VBAでOn Errorを書くと、どこでエラーになっているのかマジでわからなくなる。
  • 付属のデバッガ以外の例外機構/エラーレポーティングが貧弱であるため、全てを手で実装しなければならない。
  • ある程度の規模のアプリケーションで実践できたので、共有。

結論(テンプレート)

Worksheet / ThisWorkbook の書き方テンプレート

' /////////////////////////////////////////////////////////////////
' // 何かのボタンがクリックされたときのイベントハンドラ 
' /////////////////////////////////////////////////////////////////
Private Sub BtnA_click()
On Error Goto HANDLING
    ' メソッドに入ったら必ずロギング
    Call ModuleUtil.Log("Sheet1.BtnA_click() - start")

    Application.ScreenUpdating = False
    
    ' 入力値検証
    If Range("A2").Value2 = "" Then
         ' 注:ここでは安直にRaiseしているけど、やりたい内容によって変えてよい
         Err.Raise Description:="〇〇が空欄です"
    End If

    ' 本処理
    call ExecMain()

    ' メソッド終わったらロギング
    Call ModuleUtil.Log("Sheet1.BtnA_click() - end")
    Application.ScreenUpdating = True
    Exit Sub

' エラーハンドリング
' ------------------------
HANDLING:
    ' エラー内容をユーザーに通知する。独自のヘルパメソッドを介す。
    Call ModuleUtil.MessageBox(Err.Description)
    ' どこのエラーかしっかり記録する。独自のヘルパメソッドを介す。
    Call ModuleUtil.Log("[ERROR] Sheet1.BtnA_click():" & Err.Description)
    ' 例外は握りつぶす

    Application.ScreenUpdating = True
    
End Sub

' /////////////////////////////////////////////////////////////////
' // 本処理
' /////////////////////////////////////////////////////////////////
Private Sub ExecMain()
On Error Goto HANDLING
    ' メソッドに入ったら必ずロギング
    Call ModuleUtil.Log("ExecMain() - start")

    ' 何かのメイン処理をここで行う
    ' 試しにErrorを起こさせてみる
    Call Mid("", -1)

    ' メソッド終わったらロギング
    Call ModuleUtil.Log("ExecMain() - end")
    Exit Sub

HANDLING:
    ' どこのエラーかしっかり記録する。独自のヘルパメソッドを介す。
    Call ModuleUtil.Log("[ERROR] Sheet1.ExecMain():" & Err.Description)
    ' Errorを呼び出し上位に伝搬させる
    Err.Raise Err.Number, Err.Source, Err.Description, Err.HelpFile, Err.HelpContext
End Sub

ヘルパメソッドを実装するモジュールのテンプレート

' /////////////////////////////////////////////////////////////////
' // メッセージボックスを出力する
' // 引数省略時は、なぜか、Call で呼ばないとスタックが壊れる
' /////////////////////////////////////////////////////////////////
Public Function MessageBox(Text As String, Optional buttons As Long = 0, Optional title As String = "-1") As Long
On Error GOTO HANDLING
    If (DisabledMsgBox()) Then
        Call Log(Text)
        Exit Function
    End If
    
    Dim argTitle As String
    If (title = "-1") Then
        argTitle = ThisWorkbook.Name
    Else
        argTitle = title
    End If
        
    MessageBox = MsgBox(Text, buttons, argTitle)
    
    Exit Function
    
HANDLING:
    Call Log("[ERROR]ModuleUtil.MessageBox():" & " " & Err.Description)
    Err.Raise Err.Number, Err.Source, Err.Description, Err.HelpFile, Err.HelpContext
End Function


' /////////////////////////////////////////////////////////////////
' // ログを出力する
' /////////////////////////////////////////////////////////////////
Public Sub Log(Text As String)
    Dim StrNow As String
    StrNow = Format(Now(), "yyyy/mm/dd hh:nn:ss")
    Debug.Print "[" & StrNow & "] " & Text
    
    If (EnabledLog()) Then
        Dim ts As Object
        Set ts = CreateObject("Scripting.FileSystemObject").OpenTextFile(GetLogFilePath(), 8, True)
        With ts
            .WriteLine "[" & StrNow & "] " & Text
            .Close
        End With
    End If
    
End Sub

ヘルパメソッド

    Call ModuleUtil.MessageBox(Err.Description)
    Call ModuleUtil.Log("[ERROR] Sheet1.BtnA_click():" & Err.Description)
  • 今回携わったアプリは自動実行モード(CUI)と手動実行モード(GUI)を使い分けるため、それぞれのモードで動作を切り替える必要があった。
  • そのため、過剰にラップしている。この部分は、要件次第で、MsgBoxやDebug.Print直呼びでも構わない。

  • ただ、実運用を考えると、ログファイルへの出力機構は用意したほうが追跡性あがる。

  • 年月日時分秒の出力はマジで助かる。

開始/終了ログ

    Call ModuleUtil.Log("Sheet1.BtnA_click() - start")
    Call ModuleUtil.Log("Sheet1.BtnA_click() - end")
  • 最悪なくてもいいけどあったらうれしい。具体例は記事の最後に。

Errを捕捉したときの処理

最上位呼出階層

HANDLING:
    Call ModuleUtil.MessageBox(Err.Description)
    Call ModuleUtil.Log("[ERROR] Sheet1.BtnA_click():" & Err.Description)

それ以外の中間処理

HANDLING:
    Call Log("[ERROR]ModuleUtil.MessageBox():" & " " & Err.Description)
    Err.Raise Err.Number, Err.Source, Err.Description, Err.HelpFile, Err.HelpContext
  • とりあえずなんでもログに出しておく。本番運用で泣く。
  • 余裕があれば、引数に何渡されたか全部出しておいてもよいぐらい。
  • VBA標準関数(Mid、MkDirとか)やCreateObjectしたAPI(Scripting.xxxとか)呼ぶようなやつはとりあえず書いていたほうがよい。入力値次第ですぐにErrorを吐くAPIがあまりにも多い。
  • Erl() でエラー発生した行番号取れるよって記事を見たけど手元の環境では「0」しか取得できなかった。

以上全盛りしたらどうなるか

  • テキストログやイミディエイトウィンドウに以下が出る。
[2022/08/21 00:55:01] -------- [AUTORUN START] 〇〇〇.xlsm ---------
[2022/08/21 00:55:01] Sheet1.btnABC_click() - start
[2022/08/21 00:55:01] Sheet1.Validate() - start
[2022/08/21 00:55:01] Sheet1.Validate() - end
[2022/08/21 00:55:01] Sheet1.Generate() - start
[2022/08/21 00:55:14] Save: C:\xxx\sample.txt
[2022/08/21 00:55:15] Sheet1.Generate() - end
[2022/08/21 00:55:15] FIN.
[2022/08/21 00:55:15] Sheet1.btnABC_click() - end
[2022/08/21 00:55:15] Sheet2.btnABC_click() - start
[2022/08/21 00:55:15] Sheet2.Validate() - start
[2022/08/21 00:55:15] [ERROR] Sheet2.Validate():引数の数が一致していません
[2022/08/21 00:55:15] [ERROR] Sheet2.btnABC_click():引数の数が一致していません
[2022/08/21 00:55:16] AUTORUN RESULT: NG
[2022/08/21 00:55:16] -------- [AUTORUN END] 〇〇〇.xlsm ---------
  • 「引数の数が一致していません」とだけメッセージが出る状況に比べてだいぶマシ。

メモ:システムエンジニアの評価指標

HIGH OUTPUT MANAGEMENTを読み、今の自分がどのような尺度でシステムエンジニアを評価できるかを試し書き。 結論、やや古めのWebアプリケーションエンジニア・アーキテクトに関する評価表になった。 何か本を読むなり手を動かすなりで知識を取り入れて更新していきたい。

設計者(システムエンジニア)としての指標

  • 指標(グランドデザイン)
    • 業務領域に関する知見の深さ。
    • 様々なミドルウェア・ソフトウェアの特性の把握。
    • システムを構築する要素の物理(サービス)的・論理(サービス)的観点の知見。(実例を知れば知っているほどよい)
    • 運用時、各アクター(ユーザー、特権ユーザー、ヘルプデスク、エンジニア)がそれぞれできることと権限制御を含めたデザインができる能力。
    • 外部システムとの依存関係の構築に関する知見。
    • 個人情報やシステム監査など、社会的に要求される仕様に関する知見。
  • 指標(詳細デザイン)
    • 機能分割に関する知見。ユーザーの問題領域(ドメイン)と実装に落とした時のフローに関する知識。
    • アーキテクチャ設計パターンに関する知識。(レイヤ化、MVC、CQRSなど。各問題点の理解があればなお良い)
    • 実装パターンに関する知識。(キャッシュによる高速化、遅延評価戦略など)
    • エラー時のユーザーや保守エンジニアの行動に関するデザイン。
    • 機能変更する際、何を犠牲にするか・できないかを想定する能力。(例:パラメータ設計。変更が想定される機能に関しては、複数値を受け取れるように配列での受け取りやインタフェース定義を工夫する。それ以上の要求が来た場合は別の手段を・・・などの切り分け)

Webエンジニア(フロント)の指標

  • HTML・CSSデザインに関する知見・習熟度。テンプレ的な配色比率やレイアウト(ex:グリッドレイアウト)に関する知見。(鮮度あり。長めに見て直近5年)
  • UI・UX視点での知見。(ex:PC向けサイトをスマホで見るとどうなるか?)
  • 素材をベースとした画像加工技術やロゴなどの画像制作技術。
  • CSS命名規則など、中長期に渡るCSSの保守に関する知見。(鮮度あり。長めに見て直近5年)
  • JavaScriptの習熟度・DOMなどの機構の理解度。
  • SPA(Single Page Application)や各フレームワークに関する習熟度。
  • WebAPIの呼び出しなどに関する知見。
  • 実装が及ぼす性能・処理速度への影響に関する知見。
  • デバッグやプロファイルによるアプリケーションの挙動観測技能。
  • ほか特定ケースの技能。

Webエンジニア(バック)の指標

  • HTTPプロトコルとWebサーバーの仕組みに関するコンピュータ・サイエンス観点の知識。(リクエスト、レスポンスがそれぞれ何なのか。ブラウザはどう受けるのか)
  • データストア(データベースなど)の更新特性に関する知見。
  • 認可・認証に関する知見。
  • トランザクション設計・エラーハンドリングにおける知見。
  • 一般的な脆弱性対策に対する知見。(○○インジェクション、認証認可なしでパラメータ次第で不正操作できてしまうかの検出)
  • 実装が及ぼす性能・処理速度への影響に関する知見。
  • アプリケーション・サーバーが実稼働したときの物理構成に関する知見。(リバースプロキシやロードバランサ、CDNなど)
  • デバッグやプロファイルによるアプリケーションの挙動観測技能。
  • ほか特定ケースの技能。

テスト計画者・テスターとしての指標

  • 一般的なテスト工程に関する知見。(単体テスト結合テスト、総合(システム)テストはどんな性質の品質を検証するか?)
  • テスト工程において期待されていることや作用の理解。(品質確認、ビジネスとしての品質保証、メンバー間の認識統合など)
  • 仕様に適合しているかを検証するテストだけでなく、QA(品質保証)観点でのテストに関する知見があるか。
  • テスト自動化における前提・弊害の理解。CI(Continuus Integration)実運用の知見。
  • 境界値テスト・最大値・ゼロデータなどの一般的なテスト観点の知識。
  • 正常系(想定している仕様に適合したケース)、準正常系(想定していない状態だが正常に稼働すると保証するケース)、異常系(処理継続困難となるケース)の理解。
  • 状態を持つ実装(JavaScriptを駆使した動的な機能、スタンドアロンexeによる実装など)における検証の知識。(機能を連続して動かした時や、戻ったときに不正な表示や挙動をとるかの検証)

開発作業管理者・リーダーとしての指標

  • WBS粒度での作業進捗管理の知識。
  • 課題・ボトルネックの検出能力と問題解決手法(エスカレーション含む)の選択能力。
  • 課題に対するリカバリプランの立案・提示能力。
  • チームメンバーに対するメンターとしての技能。
  • プロジェクト内他チームとのコミュニケーションのとり方。(適切・不適切な外部委任?協力的・過剰干渉的?コントロールはできそう?)
  • プロジェクト外とのコミュニケーションのとり方。(各自の関心領域やスコープを把握し手を打っているか?)