ゼロから学ぶOAuth

第4回　OAuth Service Providerの実装

2009年3月31日

真武信和

OAuth, OAuth Service Provider, smart.fm, smart.fm API

リクエスト, Signature

最終回となる今回は，OAuth Service Providerの実装方法について，手順を追って解説します。

OAuth Service Providerがすべきこと

OAuth連載最終回は，OAuth Service Providerの実装を行います。Service Providerの役割は，大きく以下の3つに分けられます。

OAuth Consumerの管理
OAuth Request / Access Tokenの管理
OAuth経由のリソースへのアクセス管理

Rails OAuth Pluginを用いたOAuth Service Providerの実装

Railsではruby-oauth gemとOAuth Pluginを用いることで，簡単にOAuth Service Providerを実装することができます。以下実装手順です。

ruby-oauth gemのインストール（まだの場合）

gem install oauth

Railsアプリケーション作成およびpluginインストール

rails service_provider
cd service_provider
./script/plugin install git://github.com/pelle/oauth-plugin.git

ControllerおよびModel生成

./script/generate oauth_provider

これで以下のContorollerおよびModelが生成されます。

app/controllers/oauth_controller.rb
app/models/oautht_token.rb
app/models/access_token.rb
app/models/request_token.rb
app/models/client_application.rb
app/models/oauth_nonce.rb

最後にroutesとassociationを設定して，db:migrateを実行します。なおOAuth PluginはUserモデルおよびcurrent_user，login_requiredメソッドの存在を前提にしています。必要があれば適宜該当箇所を編集してください。

リスト：routes.rb

map.oauth '/oauth',:controller=>'oauth',:action=>'index'
map.authorize '/oauth/authorize',:controller=>'oauth',:action=>'authorize'
map.request_token '/oauth/request_token',:controller=>'oauth',:action=>'request_token'
map.access_token '/oauth/access_token',:controller=>'oauth',:action=>'access_token'
map.test_request '/oauth/test_request',:controller=>'oauth',:action=>'test_request'

assiciation (User model is required)

has_many :client_applications
has_many :tokens, :class_name=>"OauthToken",:order=>"authorized_at desc",:include=>[:client_application]

rake db:migrate

ここまでで前述のService Providerに（最低限）必要な機能はそろい，以下のbefore_filterが利用可能になります。

before_filter :login_or_oauth_required
before_filter :oauth_required

なおService Provider Sample - githubにもこれと同様のサンプルアプリケーションを公開していますので，適宜ダウンロードして動かしてみてください。

図1　サンプルアプリケーション

OAuth, OAuth Service Provider, smart.fm, smart.fm API

真武信和（またけのぶかず）

Cerego Japan Inc.で働くWebエンジニア。

smart.fmで外部APIとの連携機能（OAuth Consumer）の開発に携わるほか、smart.fm API（OAuth Service Provider）の開発にも携わっている。

URL：
http://matake.jp/
http://smart.fm/users/matake

ゼロから学ぶOAuth

第4回　OAuth Service Providerの実装
第3回　OAuth Consumerの実装（応用 : smart.fm APIおよびGoogle Data APIsの利用）
第2回　OAuth Consumerの実装（入門 : OAuth Access Tokenの取得と利用）
第1回　OAuthとは？―OAuthの概念とOAuthでできること

このエントリのトラックバック URI

お名前
メールアドレス
タイトル
コメント

多数の情報処理技術者試験対策書籍の発行実績を誇る技術評論社がお届けする，資格試験合格サイト「めざせ！情報処理試験パスサポ」が開設されました。

サクセスストーリーに続く，快適サーバー運用管理のヒント！: データの増大，煩雑な管理，システムダウン，セキュリティなど，迫りくる課題からシステム管理者の負担を軽くするポイントを解説します。
gihyo.jp インフラエンジニア情報局: ネットワークやITにかかわるあらゆる業種で必要とされるインフラエンジニアに向けた技術情報や心構え，その魅力について多角的に紹介。
テストエンジニアステーション: いま，ITに関わるあらゆる開発業務で注目されつつあるテスト系エンジニアをターゲットにしたコンテンツサイトを展開します。

※検索はページ右上の検索ボックスをご利用ください。

最新ソフトウェアプロテクションの導入方法（3/8～4/16）
Adobe FLASH PLATFORM CAMP Tokyo（3/16）
「組込みデータベースを利用した開発のポイントとDeviceSQLのご紹介」セミナー（3/17）

読むウェブ～本とインタラクション: ディスプレイで読む活字とそのインタラクション（interaction：相互作用）について，最新Webを紹介しながら読み解いていく。
いま，見ておきたいウェブサイト: この連載では，国内外の最新のウェブサイトを隔週更新で取り上げ，これら最新サイトの特徴や素晴らしい部分を，さまざまな角度から解説していきます。
Windows phoneアプリケーション開発入門: Windows Marcketplace for Mobileがサービス開始され，作成したアプリケーションを個人でも世界をターゲットに公開できる環境が整ってきました。これを機にWindows phoneアプリケーションの開発をしてみませんか？
ここは知っておくべき！Windows Server 2008技術TIPS: 5年ぶりのサーバOSとなったWindows Server 2008が出荷されて早2年。2009年にはR2が出荷され，再び注目を集めています。発売前から実施したトレーニングによって感じた，インフラエンジニアの方々に知っておいていただきたい機能を中心にご紹介します。
キーパーソンが見るWeb業界: 本連載はWeb Site Expert／gihyo.jpとの連動企画です。阿部淳也, 長谷川敦士, 森田雄のお三方による，Web業界をテーマにした座談会です。
きたみりゅうじの聞かせて珍プレー: ソフトウェア開発の現場で体験したトホホな失敗，思わずうなる珍プレーをきたみりゅうじ氏が四コママンガで紹介。みなさんからの投稿もお待ちしてます！
ActionScript 3.0で始めるオブジェクト指向スクリプティング: 野中文雄氏が，簡単なスクリプトは書いたことがあるという初級者を対象に，ActionScript 3.0の基本からクラス定義までを解説します。
まだ間に合う「ITパスポート」受験対策　原山先生の短期合格塾: この連載では，4月18日のITパスポート試験の受験に向けて，短い期間で効率良く受験対策を行う方法や，確実に得点するための裏ワザなどを伝授していきます。