VBAでOAuth2.0認証 – Windows11対応版

Windows11が登場し、IE11の廃止がハッキリと名言された為、Windows11上ではIE11は使えず、一応EdgeでのIE11モードがあるという状態になっています(あくまでも一時的な措置であり、Chromium EdgeやChromeへ移行する為のもの)。未だに日本の東証一部上場企業の中に社内標準ブラウザにIE11を指定してる企業があることに驚きですが。

しかし、一方でVBAでのスクレイピングやブラウザ操作、OAuth2.0認証の実行はこれまでのコードはIE11を基本としてきた為、VBAでREST APIを叩く一番最初に関門が出来てしまいました。これを突破し、Windows11上でもVBAからOAuth2.0認証できないか?にチャレンジしてみます。

今回利用するモジュールやファイル

いくつかのパターンでチャレンジをしてみている為、上記のモジュールの全てが必要なわけではありません。また、過去のIE11でOAuth2.0認証を行うコードについては、以下のエントリーを参照してください。Access Tokenの取得やExpire時のrefresh tokenを使った更新、REST APIを叩くコードは、依然として利用可能です(一部問題があります)。

今回はBox APIを叩いてみますが、Box APIの設定については本エントリーでは扱いません。

※VBAの参照設定にて、Microsoft Scripting Runtimeへの参照がオンになっている必要があります。

VBAからBox APIを叩いてみる – 準備編

Web Driverを使わない手法

本来、VBAでウェブを操作する場合は、操作するウェブブラウザに対応したWebDriverをインストールし、それを元にSelenium Basicなどで操作をするのが基本ですが、そもそもSelenium Basicなどがインストール出来ない環境が、なぜか日本企業の場合多いです(原因は全て情シス)。故に、WebDriverも使えないケースがあり、それだと詰んでしまいます。

CodeProject(要ログイン)のサイトにて有志の方が作成されたクラスライブラリを使う事でVBAから直接Chrome DevTools Protocolを叩いて操作するようです。

事前準備

  1. 掲示されてるZIPをダウンロードする
  2. Excelを起動し、開発 => Visual Basicを開く(開発タブが表示されていない場合はこちらを参考に)
  3. プロジェクトの欄にて、右クリック⇒ファイルのインポートをクリック
  4. 1.のclsおよびbasファイルをインポートする
  5. 一つ空の標準モジュールを追加しておきます。ここにコードを記述します。
  6. 名前を付けて保存でブックをxlsm形式で保存します。

これで利用できるようになりました。

認証用コード

今回は、こちらのサイトのコードをお借りしつつ、二段階認証があるサイトであるので、以前のコードを組み合わせて、Access Tokenを取得する前のAuthcodeの取得までを実装しています。

ただし、このクラスはEdgeを終了させるメソッドが無い点と、いちいちコマンドプロンプトが邪魔してくるのでちょっと現実で利用するには面倒だなと感じました。

  • ログイン用のIDとPWは、setting.iniファイルから取得させています。
  • 自動でログイン後はリダイレクトURLのサイトに来るまで、Edgeは待機させておきます。
  • リダイレクトURLのページまで来たら、URLに含まれてるAuthcodeを取り出して終了です。これをAccess Tokenと交換する別の関数に食わせます。
  • Edgeが起動した状態のまま上記コードを実行してしまうと、動作が止まります。
  • 基本操作はJavaScriptを実行してブラウザ内の要素を操作したり、alertを出したりなどの命令を実行する形です。
  • Boxのログイン画面は各要素にはName属性がついてるので、これを元に入力やクリックを行っています。
  • Edgeのクローズについては、clsEdgeに起動のコードがあるので、ここでpidを取得しておいて、クローズ時に利用すればいける気がする

WebDriverを利用する手法

事前準備

以下は、WebDriverを利用してEdgeやChromeを操作する方法になります。よって、事前にWebDriverのインストールが必要です。ただし、WebDriverを使った手法は、ChromiumのバージョンとWebDriverのバージョンを合わせる必要があるため、ブラウザのバージョンアップ時には必ず、WebDriverもアップデートが必要になるなど、こちらのサイトのVBAのように、更新をメンテするコードが必要になるかもしれません。

今回はEdge用のドライバを利用してみます。

  1. Edgeを起動し、「…」⇒ Microsoft Edgeについてを開く
  2. Edgeのバージョンが出てくるので、これを控えておく(今回は、94.0.992.50でした)
  3. WebDriverを公式サイトから、バージョンの一致するものをダウンロード。今回は、x86を選びました。
  4. 3.を解凍する
  5. 4.をドキュメントフォルダの直下にでも配置する(フォルダ名はedgedriver_win32)
  6. msedgedriver.exeまでのフルパスを取得しておく

これで準備は完了です。

図:ブラウザのバージョンと合わせるのが肝

TinySeleniumVBAを使ってみる

Selenium Basicを利用せずにWebDriverを直接操作するコードを使いやすい形でラッピングしてくれたライブラリです。Githubにて公開されており、作者様の説明はQiitaにて公開されています。WebDriverはドキュメントフォルダにでも解凍するだけで良いので、Seleniumのようにいわゆるインストーラを使っての作業が無いため、管理者権限がなくても利用できる点が大きいです。

ただし現在は必要最小限のみで、ログインまでしか実装出来ません。自身でChrome Devtool Protocolを解析して実装するならともかく、現状OAuth2.0の認証に必要な「現在のURLを取得」「現在のブラウザの読み込み状況」の2つが無いため、OAuth2.0ではちょっと使えません。

※仕組みはChromiumのPortに対して、httpアクセスでPOSTやGETで投げて操作してるようです。

事前準備

Githubで公開されてるファイルを入手し、Excelに取り込んで利用できるようにします。

  1. Githubで公開されてるZIPファイルをダウンロードする
  2. Excelを起動し、開発 => Visual Basicを開く(開発タブが表示されていない場合はこちらを参考に)
  3. プロジェクトの欄にて、右クリック⇒ファイルのインポートをクリック
  4. clsファイルが2つあるので、全てインポートする。JsonConverter.basも入れておきましょう。
  5. 一つ空の標準モジュールを追加しておきます。ここにコードを記述します。
  6. 名前を付けて保存でブックをxlsm形式で保存します。

これで利用できるようになりました

※なぜか、clsをインポートすると、標準モジュールとして認識されてしまい、これだとコードが動かないので、2つのclsファイルについては以下の処理をしました。

  1. 空のクラスモジュールを追加
  2. cls内のコードをコピペ(WebDriverとWebElementの2つの名前に変えておく)
  3. 冒頭のmultiuseのコードは不要なので削る

これで、New WebDriverの部分でエラーが出ることなく、Edge操作ができるようになりました。

図:インポートが完了したら使える

認証用コード

認証用コードのwdriverには前述のWebDriverであるmsedgedriver.exeへのフルパスを入れておきます。

  • ログイン実行まではこのライブラリでうまく実行可能です。
  • 問題はそこから先は、CDPを操作する為のメソッドが足りない為、現時点ではOAuth2.0認証には使えません

Selenium Basicを使ってみる

もっとも広く利用されてるEdgeやChromeを操縦する手法ですが、Selenium Basicは管理者権限がなければ通常はインストールが出来ない為、通常の企業のクライアントPCの場合は、情報システムにお伺いを立てて許可を得てインストールが必要になってしまいます(後述に裏技あり)。WebDriverも必要になります。この辺りのセットアップ方法は、以前のエントリーでも紹介しました。

ただ、Selenium Basic自体は既に2016年に開発がストップしており、WebDriverの入れ替えだけで延命してる状態であるため、果たしてどこまで使えるのか?という不安が残るものです。

VBAで他のアプリケーションを操作する

事前準備

SeleniumBasicのセットアップは簡単。以下の手順でセットアップをします。

  1. 配布元に行き、Release Pageへ入る
  2. 最新版をクリックしてダウンロード
  3. ダウンロードされたインストーラを起動して適当に進める。
  4. 途中、Web Driverのインストールに関する項目がでるけれど全てそのままインストール
  5. 完了したらインストール自体は完了。

ただし、このWeb Driverが最新とは限らないので、以下の手順で最新版にすげ替える

  1. WebDriverを公式サイトから、バージョンの一致するものをダウンロード。今回は、x86を選びました。
  2. 3.を解凍する。
  3. Explorerを起動し、パスの部分に「C:\Users\ユーザ名\AppData\Roaming\SeleniumBasic」を入れて移動する
  4. 3.で解凍されたmsedgedriver.exeedgedriver.exeにリネームして、3.のフォルダに上書きします
  5. コードを書くための空の標準モジュールを追加する
  6. .net Framework 3.5が必要なので、3.のscriptsフォルダ内にあるStartEdge.vbsを実行するか?手動でインストールしておく
  7. 6.をインストール完了したら一旦OSを再起動する(再起動しないとオートメーションエラーで起動しません)

これで完了です。

図:インストール自体はとても簡単

図:ブラウザとドライバのバージョンが違うとエラーが出る

認証用コード

使用するには事前に「Selenium Type Library」を参照設定で入れておく必要性があります。インストールした後であれば参照設定のリストに出てくるはずです。チェックを入れておきましょう。コードの中で事前バインディングではなく、実行時バインディングで使う場合には、以下のようなコードになります。今回のサンプルは、実行時バインディングで記述してあります。

図:事前バインディングの場合参照設定をする

  • 非常に正確に問題なくauthcodeが取得出来ます。
  • タイムアウトの設定や現在のURLの取得も非常に簡単です。
  • 終了したら、closeで閉じるだけ。後は、Access Tokenを取得する関数に食わせるだけ。
  • ヘッドレスモードで動かす事も可能ですが今回は認証ボタンは人間が押す必要があるため、途中でリダイレクトURLに来るまで待機させています。

SeleniumBasicを管理者権限無しでインストール

通常のインストーラでは、管理者権限の必要なディレクトリへのインストールが必要である点や、各種dllの登録が必要であるため、通常の企業で制限のある環境ではSeleniumBasicは使えませんでした。しかし、これを可能にする手段を考えた方がおり、インストール用のスクリプトを公開しています。

管理者権限無しでインストール手順は以下の通りです。

  1. innoextractをダウンロード、解凍する
  2. SeleniumBasicをsetupというディレクトリ作って入れておく
  3. 2.の中に入れたインストーラを掴んで、1.の中にあるinnoextract.exeにドラッグアンドドロップ
  4. インストーラが分解されて、2.のディレクトリ内にappというフォルダができる
  5. 4.のフォルダが読み取り専用になってるので、これを解除しておく
  6. 最新のEdgeやChrome用のwebdriverのexeを4.のapp内のドライバに上書きする
  7. こちらのスクリプトをテキストエディタに貼り付けて、install.cmdとして保存する
  8. 6.のスクリプトを4.のフォルダに入れて、実行する
  9. ユーザのAppData¥Roaming¥SeleniumBasicに必要なファイルがコピーされ、ライブラリがレジストリに登録される
  10. これでユーザ権限でSeleniumBasicを実行可能になる

図:インストールスクリプト実行中

図:きちんと参照先が変更されてる

WebDriverの自動更新

SeleniumBasicの弱点の一つである「WebDriverとブラウザのバージョンを一致させなければならない」点。EdgeやChromeが自動バージョンアップしてしまうと、Selenium Basicが動かなくなってしまいます。そのたびに手動でユーザが適合するWebDriverをダウンロードし、SeleniumBasicのフォルダに上書きコピーはかなりの手間です。

そこで、これを自動化するためのWebDriverManager-for-VBAがGithubにて公開されています。利用する為には以下の手順が必要です。

  1. WebDriverManager-for-VBAのWebDriverManager4SeleniumBasic.basをダウンロードする
  2. ExcelのVisual Basicを開き、1.のbasファイルをインポートする
  3. 今回は操作対象はEdgeであったので、Driver.startの部分をSafeOpen Driver, Edgeに書き換える
  4. 毎回バージョンチェックと自動ダウンロードでドライバを置き換えてから、SeleniumBasicが起動するようになります。

前述のユーザ権限でインストールを実行した場合には、第三引数にedgedriver.exeのパスを書くと書かれていますが、safeOpen関数に第三引数の受け口が無い状態なので、この場合は直接WebDriverPath関数のBrowserName.Edgeにあるパスを「AppData¥Roaming¥SeleniumBasic」に書き換えます。

書き換えた場合のコードは以下の通り。

Puppeteerを使う

概要

VBAにはSeleniumを使うSeleniumBasicライブラリがありますが、Puppeteerを使うためのライブラリは現在開発されていません。故に直接的にVBAからPuppteerを使ってのChromeの操作は出来ません。しかし、Node.js + Puppeteer + pkgを利用して、Node.jsで作ったアプリをexe化したものであれば、VBAからexeを叩き、返り値を取得する事が可能です。以前似たようなものを以下のエントリーで作成しています。

今回はこの仕組でPuppeteerを動かしOAuth2.0認証を実行してみようと思います。

資格情報マネージャ読み書きプログラムをNode.jsで作成する

事前準備

この手法はNode.jsでの開発環境とPuppeteer-core等のモジュールが必要になります。以下の手順で作成します。

  1. Node.jsでプロジェクトを作成し、puppeteer-corecommand-line-argspkgを追加しておく(pkgのみ-gオプションでインストール)
  2. コードを記述する
  3. コマンドプロンプトにて、pkg index.jsを実行し、index-win.exeを生成する

pkgにてNode.jsアプリをexe化しておくのがポイントです。また、command-line-argsにて、アプリに引数を渡せるので、ログインID、パスワード、認証用URLを渡すようにしています。

認証用コード

VBA側

  • Node.jsのexeに渡す引数は前後をダブルコーテーションで括らないと削れるので、Chr関数VBA特殊文字を加えてあります。
  • コマンドライン引数で、-u -s -gの3つのオプションを設定してるので、それぞれを引数で繋げる
  • 処理が終わるとwExec.Statusが変化するので、それを検知する無限ループを用意しておく。
  • Node.js側からの返り値はconsole.logで最後に出力した内容がwExec.StdOut.ReadAllで取得できる(ここにはAuthcodeを含めたURLが入ってる)
  • 最後にそこからAuthcodeのみを取り出す。
Node.js側

  • command-line-argsにて、exe実行時の引数を取得しています(オプション指定が必要)
  • puppeteerでchromeやEdgeを操作しています(puppeteer-coreでもEdgeは操作可能です)
  • 二段階認証の部分はユーザが入力するのですが、navigationPromiseのみでウェイトが掛かってくれます。
  • 認証実行後、page.urlでauthcode付きのリダイレクトURLの値を取得する
  • 最後にconsole.logにて出力すると、これがVBA側への返り値となります。

JSONをParseする

VBA-JSONがあるので、現在では大分、VBAでJSONを扱うのは楽になりました。また、Callbackname関数という面倒な手ではありますが、同じくJSONを解析する為に使える関数もあります。以下のエントリーで後者は扱っています。

Access VBAでNFCを使った社内アプリを作ってみる

しかし、なんだかんだいって、一番扱いやすいのはhtmlfile(Microsoft HTML Object Library)を使った手法です。こちらはWindows11でも使えるのだろうか?と調べてみましたが、何ら問題なく利用可能でした。以下のような形でParseして値を取り出します。

関連リンク

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください