862158
[Rails] Openid 사용하기
366736
2008-04-06T11:54:33Z
http://aproxacs.springnote.com/pages/862158
2008-02-26T14:37:26Z
<h4>하고자 하는 것들</h4>
<p>restful authentication plugin과 open_id_authentication plugin을 이용해서 openid를 이용한 login과정을 구현한다.</p>
<p>restful authentication을 이용해서 회원 가입 과정은 구현하지 않을 것이다. </p>
<p>첫번째로 openid를 이용해서 로그인하는 가입자는 user table에 저장한다. 이 때 name과 email도 같이 저장한다.</p>
<p>로그인 아이디 기억하기(자동 로그인) 기능을 구현한다.</p>
<p>로그인 입력 창에 openid 로고를 넣는다.</p>
<p> </p>
<h6>gem과 plugin의 설치</h6>
<p>ruby-openid gem 설치한다.</p>
<ol class="code">
<li>gem install ruby-openid</li>
</ol>
<p> </p>
<p><a href="http://agilewebdevelopment.com/plugins/openidauthentication" title="http://agilewebdevelopment.com/plugins/openidauthentication" class="external">open id authentication plugin</a> 설치힌다.</p>
<ol class="code">
<li>ruby script\plugin install open_id_authentication</li>
</ol>
<p><a href="http://agilewebdevelopment.com/plugins/restful_authentication" title="http://agilewebdevelopment.com/plugins/restful_authentication" class="external">restful authentication plugin</a> 을 설치한다.</p>
<ol class="code">
<li>ruby script\plugin install <a href="http://svn.techno-weenie.net/projects/plugins/restful_authentication/">http://svn.techno-weenie.net/projects/plugins/restful_authentication/</a></li>
</ol>
<p> </p>
<h6>migration 을 이용한 db table 생성</h6>
<p>restful authentication의 generate를 이용해서 user와 sessions를 생성한다.</p>
<ol class="code">
<li>ruby script/generate authenticated user sessions</li>
</ol>
<p>위 명령은 user model 과 sessions controller, users controller 를 생성한다. users controller가 필요없다면 삭제해도 좋다.</p>
<p> </p>
<p>user table에 identity_url을 추가한다.</p>
<ol class="code">
<li># db/migrate/001_create_users.rb</li>
<li>t.column :identity_url, :string</li>
<li>t.column :name, :string</li>
</ol>
<p> </p>
<p>rake를 이용해서 open_id_authentication migration을 추가한다.</p>
<ol class="code">
<li>rake open_id_authentication:db:create</li>
</ol>
<p>db/migrate/002_add_open_id_authentication_tables.rb 파일이 생성된다.</p>
<p> </p>
<p>migrate를 수행해 db table을 생성한다.</p>
<ol class="code">
<li>rake db:migrate</li>
</ol>
<p> </p>
<h6>기타 설정</h6>
<p>application controller에 다음을 추가한다. 기본적으로 모든 controller들의 요청이 login_required에 의해 login을 요구하도록 하고 있다.</p>
<ol class="code">
<li>include AuthenticatedSystem <br />
before_filter :login_required</li>
</ol>
<p> </p>
<p>login이 필요없는 controller 혹은 action에 대해서는 skip_before_filter를 이용할 수 있다.</p>
<p>sessions controller는 login_required가 필요없으니 다음을 추가한다. </p>
<ol class="code">
<li>skip_before_filter :login_required</li>
</ol>
<p> </p>
<p>routes.rb를 다음과 같이 한다.</p>
<ol class="code">
<li>map.resources :users<br />
map.open_id_complete 'session', :controller => "sessions", :action => "create", :conditions => { :method => :get }<br />
map.resource :session</li>
</ol>
<p>map.open_id_complete는 openid provider로 부터 인증이 완료되었음을 알리는 request를 sessions controller의 create action으로 보내기 위함이다. 이 요청은 open_id_authentication plugin에서는 GET "/session?각종_파라미터들" 이다. 그래서 /session에 대한 get 요청을 create action으로 보낸다. 이것이 마음에 들지 않는다면 return_to option을 조절해서 원하는 값으로 바꿀 수 있다. return_to option에 대해서는 밑에 다시 설명한다.</p>
<p> </p>
<h5>view의 구현</h5>
<p>views/sessions/new.html.erb 를 다음과 같이 한다.</p>
<ol class="code">
<li><%= stylesheet_link_tag "login" %><br />
<br />
<div class="message"><br />
<%= logged_in? ? "로그인되었습니다." : "로그아웃 상태입니다." %><br />
<%= link_to "로그아웃", session_url, :method=>:delete if logged_in? %><br />
</div><br />
<br />
<% form_tag(session_url) do %><br />
<label for="openid_url">OpenID:</label><br />
<%= text_field_tag "openid_identifier", "", :class=>"openid" %><br />
<br/><br />
<%= check_box_tag 'remember_me' %><br />
<label for="remember_me" class="rememberMe">아이디 기억하기</label><br />
<% end %></li>
</ol>
<ul>
<li>login.css를 포함하고,</li>
<li>로그인 여부를 보여주고,</li>
<li>openid를 입력할 수 있는 form을 보여주고, <a href="http://openid.springnote.com/pages/471141.xhtml" title="http://openid.springnote.com/pages/471141.xhtml" class="external">openid 권장 표준 스타일 가이드</a>에 따르면 openid input의 이름을 openid_indentifier로 하라고 한다.</li>
<li>아이디 기억하기 checkbox를 보여준다.</li>
</ul>
<p> </p>
<p>login.css를 다음과 같이 작성해서 style을 준다.</p>
<ol class="code">
<li>body {<br />
margin: 50px 0px 0px 0px;<br />
text-align: center; <br />
font-size: 14px;<br />
}<br />
div.message {<br />
margin: 10px 0px;<br />
}<br />
input.openid {<br />
background:transparent url(/images/openid_bg.gif) no-repeat left center;<br />
padding-left: 18px;<br />
border: 1px solid;<br />
}</li>
</ol>
<p>openid logo(openid_bg.gif)는 <a href="http://openid.net/logos/">http://openid.net/logos/</a> 에서 적당한 것으로 다운 받자.</p>
<p> </p>
<h5>model의 구현</h5>
<p>user model은 restful authentication에 의해 이미 생성되어 있다. openid 인증을 적용하기 위해서는 약간의 수정이 필요한데, 그 내용은 다음과 같다.( 변경된 내용만 적는다. )</p>
<ol class="code">
<li> validates_presence_of :email<br />
validates_presence_of :login, :if => :not_openid?</li>
<li> validates_length_of :login, :within => 3..40, :if => :not_openid?</li>
<li> validates_uniqueness_of :login, :email, :case_sensitive => false, :allow_nil => true</li>
<li> </li>
<li> attr_accessible :login, :email, :password, :password_confirmation, :identity_url </li>
<li> </li>
<li> def password_required?<br />
not_openid? && (crypted_password.blank? or not password.blank?)<br />
end <br />
def not_openid?<br />
identity_url.blank?<br />
end</li>
</ol>
<p>주된 내용은 "openid를 이용하는 사용자에게는 login, password같이 필요없는 것들에 대한 validation check을 하는 않는다." 이다.</p>
<p> </p>
<h5>Controller 의 구현</h5>
<p>sessions controller의 내용은 꽤 길다.</p>
<ol class="code">
<li>class SessionsController < ApplicationController<br />
skip_before_filter :login_required<br />
<br />
def create<br />
if using_open_id? params[:openid_identifier]<br />
open_id_authentication params[:openid_identifier]<br />
else<br />
password_authentication(params[:login], params[:password])<br />
end<br />
end<br />
<br />
def destroy<br />
self.current_user.forget_me if logged_in?<br />
cookies.delete :auth_token<br />
reset_session<br />
flash[:notice] = "로그아웃 되었습니다."<br />
redirect_back_or_default('/')<br />
end<br />
<br />
protected<br />
def password_authentication(login, password)<br />
self.current_user = User.authenticate(login, password)<br />
if logged_in?<br />
successful_login<br />
else<br />
failed_login "Sorry, that username/password doesn't work"<br />
end<br />
end<br />
<br />
def open_id_authentication(openid_url) <br />
authenticate_with_open_id(openid_url, :required=>[:nickname, :email],<br />
:return_to=>openid_return_url) do |result, identity_url, registration|<br />
if result.successful?<br />
@user = User.find_or_initialize_by_identity_url(identity_url) <br />
if @user.new_record? <br />
@user.name = registration['nickname']<br />
@user.email = registration['email']<br />
@user.save #TODO : need to check validation<br />
end <br />
self.current_user = @user<br />
successful_login <br />
else<br />
failed_login result.message<br />
end<br />
end<br />
end<br />
<br />
private <br />
def openid_return_url<br />
"#{request.protocol + request.host_with_port + request.relative_url_root + request.path}" +<br />
"?remember_me=#{params[:remember_me]}"<br />
end<br />
<br />
def successful_login <br />
if params[:remember_me] == "1"<br />
self.current_user.remember_me <br />
cookies[:auth_token] = { :value => self.current_user.remember_token , :expires => self.current_user.remember_token_expires_at }<br />
end<br />
redirect_to(root_url)<br />
end<br />
<br />
def failed_login(message)<br />
flash[:error] = message<br />
redirect_to(new_session_url)<br />
end<br />
end</li>
</ol>
<p>openid_identifier가 있다면 이 사용자는 openid를 이용해서 로그인을 하는 것이다. 만약 그렇지 않다면 일반적인 login/password로 로그인을 하려는 것이다. login/password 인증이 필요없다면 password_authentication 를 빼도 된다.</p>
<p>로그아웃 과정은 평범하다.</p>
<p>open_id_authentication 를 살펴보면,</p>
<p>인증을 하면서 nickname과 email을 요청한다.</p>
<ol class="code">
<li> authenticate_with_open_id(openid_url, <strong>:required=>[:nickname, :email]</strong>,<br />
:return_to=>openid_return_url) do |result, identity_url, registration|</li>
</ol>
<p>만약 처음으로 로그인하는 사용자라면 user 를 하나 생성하고 name과 email을 저장한다.</p>
<ol class="code">
<li> @user = User.find_or_initialize_by_identity_url(identity_url) <br />
if @user.new_record? <br />
@user.name = registration['nickname']<br />
@user.email = registration['email']<br />
@user.save #TODO : need to check validation<br />
end </li>
</ol>
<p>인증이 잘 되었다면 current_user를 user로 해 주자.</p>
<p> </p>
<h6>로그인 기억하기 구현</h6>
<p>openid provider가 인증을 마치고 응답을 줄때는 :return_to 의 값으로 응답한다.(꼭 :return_to의 값은 아니다. 여기에 다른 파라미터들도 여러개 붙는다.) (진이가 오늘 이쁜짓을 많이하네.. 이제 정말 고양이 스럽다. 난 그 깊은 속을 알 길이 없구나.) 여기서 return_to의 값으로 정의한 openid_return_url은 remember_me 가 parameter로 포함되어 있다. 그래서 "http://site.co.kr/sessions?remember_me=1" 같은 모양이다. 만약 응답 url이 "/sessions 인 것이 마음에 들지 않는다면 원하는 값으로 수정할 수도 있다. 수정 후에는 routes.rb에 그 내용을 써주는 것을 잊지 말자.</p>
<ol class="code">
<li> authenticate_with_open_id(openid_url, :required=>[:nickname, :email],<br />
<strong>:return_to=>openid_return_url</strong>) do |result, identity_url, registration|</li>
<li>...</li>
<li> def openid_return_url<br />
"#{request.protocol + request.host_with_port + request.relative_url_root + request.path}" +<br />
"?remember_me=#{params[:remember_me]}"<br />
end</li>
</ol>
<p>:return_to options을 굳이 적어주는 이유는 remember_me 정보를 보전하기 위함이다. 이 정보는 인증이 잘 이루어진 후 로그인 정보를 기억할지를 결정하는 데 사용된다.</p>
<ol class="code">
<li> def successful_login <br />
if params[:remember_me] == "1"<br />
self.current_user.remember_me <br />
cookies[:auth_token] = { :value => self.current_user.remember_token , :expires => self.current_user.remember_token_expires_at }<br />
end<br />
redirect_to(root_url)<br />
end</li>
</ol>
<p> </p>
<h4>써보니</h4>
<p>와.. 생각보다 훨씬 간단하다.</p>
<p>난 아직 openid 스펙도 잘 모르는데, 이 기능을 구현할 수 있다는 사실이 놀랍고, 두렵다. </p>
<p>(진이는 커가면서 어리광이 느는 것 같다.)</p>
<p> </p>
<h4>참조</h4>
<p><a href="http://www.bencurtis.com/archives/2007/03/rails-openid-and-acts-as-authenticated/" title="http://www.bencurtis.com/archives/2007/03/rails-openid-and-acts-as-authenticated/" class="external">acts as authentication plugin과 openid 를 같이 사용하기</a></p>
<p><a href="http://openid.springnote.com/pages/471141.xhtml" title="http://openid.springnote.com/pages/471141.xhtml" class="external">openid 권장표준 스타일</a></p>
<p><a href="http://openid.net/specs/openid-authentication-2_0.html" title="http://openid.net/specs/openid-authentication-2_0.html" class="external">openid 2.0 스펙</a></p>
<p><a href="http://media.railscasts.com/videos/068_openid_authentication.mov" title="http://media.railscasts.com/videos/068_openid_authentication.mov" class="external">railscast</a></p>
<p><a href="http://shinji.springnote.com/pages/475676" class="external" title="http://shinji.springnote.com/pages/475676">http://shinji.springnote.com/pages/475676</a></p>
http://aproxacs.myid.net/
http://aproxacs.myid.net/
190