危険なデフォルトを、1 行もデータ移行せずにオフにした話
JIT プロビジョニングは、エンタープライズ SSO を魔法のように感じさせる機能です。新入社員が会社の ID プロバイダー経由でサインインし、その人のアカウントがまだアプリに存在しなくても、アサーションからその場で作成されます。誰もチケットを起票せず、誰も招待されず、本人はそのまま仕事を始められます。
これを逆方向から読むと、その ID プロバイダーを支配している者なら誰でも、ある人物が存在すると主張するだけで顧客のテナントにアカウントを作れる機能でもあります。接続が 1 社のディレクトリに厳密にスコープされていて、そこにいる全員がアクセスすべき人なら問題ありません。しかし、その接続が共有ディレクトリだったり、請負業者用のテナントだったり、ID プロバイダーが身元を保証する人の集合が、顧客が招き入れるつもりだった人の集合よりずっと大きい、あの広大なフェデレーションの 1 つだったりすると、話は変わります。
私たちの実装はデフォルトでオンでした。誰かがそう決めたからではありません。ここが立ち止まって考えるべき点です。デフォルトでオンになっていたのは、このフィールドを追加したとき、それを表すブール値の名前が DisableJitProvisioning で、未設定のブール値は false であり、false は「無効にしない」を意味していたからです。誰も選ばなかったデフォルトについて最も安全な解釈は、それが偶然の産物だということです。そしてこの偶然は、すでに動作として定着していました。
影響範囲は正確に述べておきます。「誰でも誰のアカウントでも作れる」ほどひどい状態だったことは一度もないからです。プロビジョニングの前には、すでに 2 つのゲートがありました。接続には許可するメールドメインのリストを設定でき、その範囲外のアサーションは拒否されます。接続には招待属性を必須にする設定もでき、招待されていないユーザーは拒否されます。デフォルトがオンであることの本当のリスクは、そのどちらも設定されていない接続でした。それはまさに、とにかく SSO を動かすために誰かが急いで設定した接続の姿そのものです。
デフォルトの反転は 1 単語。安全な反転はそうはいかない
誰もが思い浮かべる変更は、フィールド名を JitProvisioningEnabled に変えてデフォルトを false にすることです。新しい接続はデフォルトで安全になり、これで完了。
ところが、このフィールドは永続化されており、ストレージにはこのフィールドが存在する前に書き込まれた接続があります。それらの行にはカラムそのものがありません。そうした行がどう扱われるかは、ブール値がどちら向きかで完全に決まります。欠けたカラムは、どちらの場合でも false としてデシリアライズされるからです。古い否定形の名前なら、欠けていることは「無効にしていない」を意味し、プロビジョニングは続きます。新しい肯定形の名前なら、欠けていることは「有効にしていない」を意味し、プロビジョニングは止まります。
つまり単純に名前を変えると、JIT プロビジョニングがオンだった頃に顧客が設定したすべての接続で、プロビジョニングが黙ってオフになります。顧客は何も選んでおらず、何も知らされず、最初にそれを知るのは、サインインできない社員からの連絡です。それが何時に起きるかはわかりません。これはセキュリティの改善ではなく、デプロイによって届けられる障害です。
わかりやすい答えはバックフィルです。保存済みのすべての接続を走査してカラムを明示的に書き込み、そのあとでデフォルトを反転する。これでうまくいきますが、それは書いて、テストして、すべてのテナントのストレージに対して実行し、それに依存するコードを出荷する前にどこでも完了したと確信しなければならないマイグレーションです。たかがブール値 1 つのために。
二重否定
私たちはマイグレーションを書きませんでした。保存されたカラムは古い否定形の意味を永遠に保ち、モデルにはその手前に肯定形のプロパティが加わります:
public bool JitProvisioningEnabled { get; set; }
public bool DisableJitProvisioning
{
get => !JitProvisioningEnabled;
set => JitProvisioningEnabled = !value;
}
肯定形のプロパティが本物で、実際のストレージを背後に持ち、デフォルトは false です。これが新しい安全なデフォルトです。否定形の名前は、今では双方向に反転する計算済みのエイリアスになっています。
古い行をたどってみましょう。カラムが欠けているので false として読まれ、DisableJitProvisioning のセッターが false で実行され、JitProvisioningEnabled は true になります。接続は所有者が設定したとおりにプロビジョニングを続け、何もマイグレーションしていません。新しい接続もたどってみましょう。誰もどちらのプロパティも設定しないので、JitProvisioningEnabled はデフォルトの false のままで、誰かがオプトインするまで、その接続は未知のユーザーを拒否します。
どちらの動作も同じコードから生まれ、分岐もバージョンフラグもなく、データには一切触れていません。永続化されたビットの意味は一度も変わっていません。変わったのは、それが格納されるフィールドだけです。そして反転は、読み込みのたびに実行されるプロパティのセッターの中で起きます。
その代償
これはタダではなく、請求書は API の境界に届きます。どちらのプロパティも public なので、どちらもシリアライズされます。接続を読み取り、何かを変更して書き戻すクライアントは、同じことを表す 2 つのプロパティを送ることになります。デシリアライズはペイロード内に現れた順に適用されるので、最後のものが勝ちます。肯定形のプロパティを true にしても、取得したオブジェクトに古い否定形のプロパティが残っていると、送っているつもりのなかったフィールドによって、あなたの変更は黙って取り消されます。
私たちがこれを見つけたのは、この手の問題がいつも見つかる形、つまりフラグをオンにしてからオンであることをアサートするテストででした。そこから生まれたルールは、読み取り・変更・書き込みを行うときは必ず両方の形を明示的に設定する、というものです。私たち自身のエンドツーエンドテストも、理由を説明するコメント付きで今はそうしています。この仕掛けを採用するなら、このコストも見込んでおいてください。双方向のエイリアスはマイグレーションを不要にしてくれますが、その代わりにワイヤー上の曖昧さという代償を求めます。
反転が明らかにしたバグ
ここからは、ブール値に限らず一般化できる話です。この変更を行っている最中に、OIDC 接続を作成する管理エンドポイントが、このフラグを一度も設定していなかったことがわかりました。誤った値を設定していたのではありません。単にまったく代入しておらず、リクエストオブジェクトにも代入元となるフィールドがありませんでした。
デフォルトが誰もが望む値である限り、これは見えませんでした。すべての接続がプロビジョニング有効の状態で作られ、それは配線を忘れたコードがどのみち生み出していたはずの結果と同じだったので、気づくべきことは何もなく、失敗しうるテストもありませんでした。デフォルトが反転した瞬間、その同じ欠落は「新しく作成された OIDC 接続はすべてプロビジョニングがオフで、オンにする手段がない」に変わりました。これは微妙なバグなどではまったくありません。
デフォルトとは、そのフィールドを設定し忘れたすべてのコードパスが持つ値です。デフォルトが都合のよい値である間は、そうしたパスと、意図的に設定しているパスとは区別がつきません。デフォルトを変えることは、新しい動作を変えるだけではありません。写真を現像するようなものです。黙ってデフォルトに依存していたものすべてが一度に見えるようになり、その一部は壊れています。
動かなかったチェックボックス
デフォルトが潜む最後の場所はユーザーインターフェースです。私たちのポータルには「JIT プロビジョニングを無効にする」というチェックボックスがあり、デフォルトでは未チェックでした。今は「JIT プロビジョニングを有効にする」となっていて、やはりデフォルトでは未チェックです。同じ位置の同じウィジェットで、初期状態も同じ、そして意味は正反対です。
これは本当に危険な種類の変更なので、一覧画面にバッジを追加しました。オプトインしていない接続にはすべてラベルが付くので、何も開かなくても状態がわかります。以前は逆の意味だった未チェックのボックスから推測する必要はありません。
そして、プロビジョニングがオフの接続が未知の人物のアサーションを受け取っても、ユーザーがスタックトレースの画面に放り出されることはありません。元のアプリケーションに戻され、アカウントが見つからないので管理者に連絡してほしいというエラーが表示されます。これは、今起きたことを正確に、かつ行動につながる形で伝えたものです。
デフォルトは API の一部であり、4 つの集団に受け継がれる
デフォルトは API の一部です。それを受け継ぐのは、そのフィールドより前から存在する保存済みの行、そのフィールドを省略している設定ファイル、それを一度も設定しないコードパス、そして未チェックの状態でそのデフォルトを表現しているユーザーインターフェースのコントロールです。デフォルトを動かす前に、この 4 つの集団を洗い出し、それぞれについて新しいデフォルトに従うべきか、古い動作を維持すべきかを決めてください。たいていは集団ごとに答えが異なり、それこそが設計作業です。
そして、ブール値を 1 つ動かすためにデータマイグレーションを書こうとしていると気づいたら、まず、意味はそのままにして、名前とデフォルトだけをその手前で動かせないか検討してください。ストレージは考えを変えるのに高くつく場所です。プロパティのセッターは安く済む場所です。
慎重なデフォルトがあらかじめ選ばれた状態で ID プロバイダーを使いたいなら、Authagonal はすべての SSO 接続でプロビジョニングをオプトインにしており、どの接続がオプトインしているかをはっきり示します。