関数をFunctor/Applicative/Monadにする

『プログラミングHaskell 第2版』の12章「モナドなど」の演習*1で型 (a ->) をFunctor(関手)、Applicative、Monadにするという問題があり、少しわかりにくかったので、いまの自分自身の理解をまとめました。

型(a ->)とは

部分適用された関数の型を(a ->)(もしくは->を2引数関数とみて((->) a))と表現する*2。この型の意味は「aを部分適用済みの関数」である。部分適用するのは、ある型をFunctorにするには型コンストラクタが持つ型変数が1つでなければならないことによる。

実際のインスタンス宣言はControl.Monadに存在する。

Functorにする

「型変数を持つならモナドになるか試してみるのが自然な流れ」と書いてあるので、(a ->)もMonadにしていく。

まずFunctorにする。Functorにするにはfmapを定義する必要がある。演習問題のヒントに書いてあるとおり、(a ->)に対するfmapの型がどうなるかを考える。Functor型クラスにおけるfmapの型は次のとおり。なお、aという変数は(a ->)で使われているので、これ以降新たに現れる型変数はbから始める。

fmap :: (b -> c) -> f b -> f c

まず第2引数f bから考える。今回(a ->)をFunctorにするので、ある構造を表すf(a ->)に該当する。つまり、fは「引数として取る型の値を返す部分適用済みの関数であること」を表す。つまりf bと書くとa -> bとなる。ここから(a ->)に対してfmapの型を次のように表現できる:

fmap :: (b -> c) -> (a -> b) -> (a -> c)

このfmapの型をよく見ると、関数合成そのものになっている。よって、(a ->)は次のようにFunctorとできる。

instance Functor ((->) a) where
  fmap = (.)

Applicativeにする

続いて、(a ->)をApplicativeにするにはpure<*>を定義する。Applicative型クラスにおけるpure<*>の型は次のとおり。

pure :: a -> f a
(<*>) :: f (a -> b) -> f a -> f b

まずpureから考える。型bを持つある値を(a ->)の文脈に持ち込むと考えると、型bの値を受け取り、つねにその値を返す関数(a -> b)を返せばよい。

pure :: b -> (a -> b)

これはb -> a -> bと見なせるのでconstと同じである。

次に<*>も型から考える。これまでどおりfを部分適用済みの関数(a ->)と見なすと、

  • f ba -> b
  • f ca -> c
  • f (b -> c)a -> b -> c

となる。よって

(<*>) :: (a -> b -> c) -> (a -> b) -> (a -> c)

となる。

結果の型がa -> cという関数なので、ある引数fgに関して、f <*> gは型aの1引数関数と考えればよい。また、関数a -> b -> cと関数a -> bに型aの値を適用すると、関数b -> cと型bの値になる。型cを返す関数を作る必要があるので、後者のbの値を関数b -> cに適用すればよい。これらを合わせて、次のように(a ->)をApplicativeにすることができる。

instance Applicative ((->) a) where
  pure = const
  f <*> g = \a -> f a (g a)

ここではg aが型bの値、f aが関数b -> cである。

関数がApplicativeだと、二つの関数をそれぞれ適用して結果を足すコードを逐次的に書けたりする。

f = fmap (+) (+ 5) <*> (* 100) -- 5足した値と100かけた値の合計
f 30 -- 3035

また、pure<*>はそれぞれSKIコンビネータにおけるKとSにあたる*3

Monadにする

最後に、(a ->)をMonadにする。Monadにするにはreturn>>=を定義する必要があるが、returnpureと同じなので>>=だけ考える。

型から考えると、Monad型クラスで>>=の型は次のように定義されている。

(>>=) :: m b -> (b -> m c) -> m c

mを部分適用済みの関数(a ->)と見なすと、

  • m ba -> b
  • b -> m cb -> a -> c
  • m ca -> c

となる。よって

(>>=) :: (a -> b) -> (b -> a -> c) -> (a -> c)

となる。

Applicativeと同様に結果の型がa -> cという関数なので、(a -> b) >>= (b -> a -> c)は型aの1引数関数と考えればよい。Applicativeのときと同じように考えると、次のように(a ->)をMonadにすることができる。

instance Monad ((->) a) where
  return = pure
  f >>= g = \a -> g (f a) a

ここではf aが型bの値、gが関数b -> a -> cである。

関数がMonadだと、Applicativeで実現した「二つの関数をそれぞれ適用して結果を足すコード」を次のようにdo記法で書ける。入力した数値(この例だと30)を環境として持ちながら計算していると見なせる*4

f = do
  g <- (+ 5)
  h <- (* 100)
  return $ g + h

f 30 -- 3035

*1:12.5「練習問題」の2, 3, 6

*2:一般的にはrを使って(r ->)と書くが、ここでは本の記法にしたがって(a ->)とする。参考:"Functors, Applicative Functors and Monoids"

*3:12.5「練習問題」の3より

*4:Haskell 状態系モナド 超入門 - Qiita

WebAuthnによる認証機能を作りながら理解を深める

何をやったか

最近の仕事柄興味があったのと、WEB+DB PRESS Vol.114の特集2を読んだこともあって、理解を深めるためにWebAuthnでの公開鍵登録(今回はサインアップを兼ねる)、認証だけできる簡単なWebアプリを作りました。リポジトリのREADMEに様子のGIFアニメを貼っています*1。今回はChrome 80とTouch IDで試しています:

GitHub - kymmt90/webauthn_app

このボタンをクリックするとHerokuにデプロイできます。リポジトリのREADMEにも同じボタンを置いています:

Deploy

デプロイ後に環境変数 WEBAUTHN_ORIGINhttps://<Herokuアプリ名>.herokuapp.com を追加してください。

理解できた点

WebAuthn自体の詳しい説明は、Web上のリソースを参照したほうがよいので、今回はとくに書いていません。

登場する各ロールの役割

WebAuthの認証フローを見ると用語が多いですが、概ね次のように理解しました。

  • Authenticator
    • ユーザーエージェントからアクセスされる認証器
    • ハードウェアトークン(Yubikey、Titanなど)やデバイス埋め込みの認証機構(Touch IDなど)
  • Relying Party (RP)
    • Authenticatorからもらった情報をもとに認証するサーバ
    • ブラウザから公開鍵とattestation(認証器自体の正当性証明)を受け取り、公開鍵をアカウントと紐付けて保存する
    • ブラウザからassertion(認証時の署名など)を受け取り、認証する

実装の感触

個人的にRailsだとさっと実装できるので、今回はRailsでやりました。webauthn-rubywebauthn-jsonの組み合わせで問題なく実装できます*2。実装項目は次のような感じです。

サーバ

  • クライアントがWebAuthn APIへ渡すためのオプションやチャレンジ値を返すAPIを追加する
    • 公開鍵登録時は GET /webauthn/credential_creation_options
      • WebAuthn::Credential.options_for_create を使う
    • 認証時は GET /webauthn/credential_request_options
      • WebAuthn::Credential.options_for_get を使う
  • 送られてきたアカウント名、公開鍵、attestationから、アカウントを作成して公開鍵をそのアカウントに紐付けて保存するAPIを追加する
    • POST /users
      • WebAuthn::Credential.from_create / WebAuthn::PublicKeyCredentialWithAttestation#verify を使う
  • 送られてきたアカウント名とassertionから、パスワードレス認証するAPIを追加する
    • POST /session
      • WebAuthn::Credential.from_get / WebAuthn::PublicKeyCredentialWithAssertion#verify を使う

クライアント

  • サインアップ用フォーム
    • サーバからもらったオプションを navigator.credentials.create() に渡して認証器からattestationをもらいサーバへ送る
  • ログイン用フォーム
    • サーバからもらったオプションを navigator.credentials.get() に渡して認証器からassertionをもらいサーバへ送る

RPサーバは署名、オリジン、チャレンジ値、認証回数の検証などプロトコルに規定されている検証を実行する必要がありますが、ライブラリである程度カバーできると思います。

認証体験

ふだんパスワードマネージャを使ってはいますが、やはりパスワードレスだと認証の体験がかなり簡単に感じました。これで多要素も満たせる(所持、生体)のも便利ですね。

*1:なぜかはてなブログにGIFを貼ろうとするとエラーになった

*2:webauthn-rubyはデモアプリも公開していて、今回はそれを模倣している

外部サービスのリソースをJSONシリアライザブルなActive Modelとして表現する

RailsでWeb APIを作っていて、外部のサービスからリソースを取得し、DBには保存しないもののレスポンスに含めてクライアントに返したい、ということがありました。このとき次のモジュールが役立ったので紹介します。

モジュールの説明

ActiveModel::Model はActive Recordとも互換性のあるインタフェースでRails上のモデルとして扱える機能がいろいろ入るモジュールです。ActiveModel::AttributesAttributes APIを提供するモジュールです。最後の ActiveModel::Serializers::JSON は有名なActiveModelSerializers gemと名前は似ているのですが別物の、rails/railsactivemodel gem内に含まれるモジュールです。

実現方法

POROに ActiveModel::Serializers::JSON をincludeして render :json に渡すと、Attributes APIの attribute で定義した属性からなるJSONをシリアライズできるようになります。これを利用して、次のようなクラスを作りました。

まず、外部サービスから得られるリソースを表すクラスを作り、上述したモジュールをincludeします。

class ExternalServiceResource
  include ActiveModel::Model
  include ActiveModel::Attributes
  include ActiveModel::Serializers::JSON
end

次に、ExternalServiceResource をもとに具体的なリソースを表すクラスを作ります。ここでは外部ブログサービスから記事リソースを取得しているとします。

class Article < ExternalServiceResource
  attribute :title, :string
  attribute :content, :string
  attribute :status, :integer
  attribute :created_at, :datetime

  DRAFT = 0
  PUBLIC = 1
  DELETED = 2

  def unavailable?
    status.in?([DRAFT, DELETED])
  end
end

class Blog
  # ...

  def articles
    raw_response = client.articles
    raw_articles = JSON.parse(raw_response)['articles']

    raw_articles
      .map { |raw_article| Article.new(raw_article) } # 生JSONをモデルオブジェクトへ変換
      .reject(&:unavailable?)
  end

  private

  def client
    # 外部サービスのWeb APIを叩いてJSONを返すクライアント
  end
end

これらを使うと、外部サービスのリソースも含んだJSONを返すエンドポイント自体は、シンプルに実装できます。

class ArticlesController < ActionController::API
  # articles#index で外部ブログ記事のうちpublicなものを取得できる
  def index
    render json: { articles: blog.articles }
  end

  private

  def blog
    # Blogのインスタンスを返す
  end
end

pros/cons

この方法の利点は、サードパーティgemのActiveModelSerializersを使うのに比べると、Railsのモジュールだけで実現できてシンプルというところや、モデルとして外部リソースを表現できるので、そのリソースに関するロジックをモデルに置くことができるという点が挙げられます。

逆に、欠点として、自前実装になるのでうまくやらないと負債になりそうな点や、リソースの構造がネストするときに、Attributes APIでは ActiveModel::Type.register を使って自前の型を定義していくと実装がやや面倒という点です。ただし、ネストしているリソースについて型を定義せず、次のように型を指定せずに属性を定義することもできるにはできます。

# Article#author に入れるためのモデル
class Author < ExternalServiceResource
  attribute :name
  # ...
end

class Article < ExternalServiceResource
  attribute :title, :string
  attribute :content, :string
  attribute :status, :integer
  attribute :created_at, :datetime

  # Authorのオブジェクトを入れるつもりだが、型指定はとくになし
  attribute :author

  # ...
end

Active Recordでstring型属性を暗号化するためのRailsプラグインを作った

複数プロジェクトで、Active Recordのstring型を拡張して透過的に文字列を暗号化/復号できる型をattributes API(ActiveRecord::Attributes) を使って書く場面を目撃したり、自分でも書く機会があったので、Railsプラグインに切り出してみました。

github.com

使い方は次のとおりです。

# users.tokenはstring型
class User < ActiveRecord::Base
  attribute :token, :encrypted_string
end

# 環境変数かconfigで設定する
ENV['ENCRYPTED_STRING_PASSWORD'] = 'password'
ENV['ENCRYPTED_STRING_SALT'] = SecureRandom.random_bytes
# ActiveRecord::Type::EncryptedString.encryption_password = 'password'
# ActiveRecord::Type::EncryptedString.encryption_salt = SecureRandom.random_bytes

# DB内では暗号化されているがオブジェクト経由で取り出すと復号されている
user = User.create(token: 'token_to_encrypt')
ActiveRecord::Base.connection.select_value('SELECT token FROM users') #=> "eVZzbUlXME1xSlZ5ZWZPQnIvY..."
user.token #=> "token_to_encrypt"

内部的には ActiveSupport::MessageEncryptor を使う、よくある実装になっています。gemにすることですぐに使えるようになって便利ですね。

OpenAPI 3ドキュメントも使えるSchemaConformist 0.3.0をリリースした

rubygems.org

これまでのバージョンの差分はOpenAPI 3ドキュメントが使えるようになった点です。OpenAPI 3に対応したCommittee v3の機能を使うことで、integration test/request spec実行中にOpenAPI 3ドキュメント中のスキーマに基づいたJSONレスポンスのバリデーションを自動実行できるようになりました。

OpenAPI 3についてはRubyKaigi 2019での@ota42yさんの発表資料や、WEB+DB PRESS Vol.108の特集1が参考になります。

speakerdeck.com

gihyo.jp

以上の対応に伴って、Committeeの機能を利用して自動でドキュメントフォーマットが判別できるようになったので、オプション driver の指定は不要になりました。また、オプション schema_path については必須とすることにしました。これは、schema_path を指定しなかったときにデフォルトで入るパス(public/swagger.json など)がとくに一般的なものではないことと、driver をオプションとして渡さなくなったことによります。

他には、ignored_api_paths は正規表現だけでなくふつうのStringも渡せるようにしました。渡された文字列と前方一致するパスを検索して、そのパスで表されるエンドポイントについてはテスト実行時にバリデーションをスキップします。

もし仮に使っている人がいれば、なにかおかしいところがあったら教えてください。