|
# Copyright (C) 2010 Google Inc. |
|
# |
|
# Licensed under the Apache License, Version 2.0 (the "License"); |
|
# you may not use this file except in compliance with the License. |
|
# You may obtain a copy of the License at |
|
# |
|
# http://www.apache.org/licenses/LICENSE-2.0 |
|
# |
|
# Unless required by applicable law or agreed to in writing, software |
|
# distributed under the License is distributed on an "AS IS" BASIS, |
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
# See the License for the specific language governing permissions and |
|
# limitations under the License. |
|
|
|
"""Command-line tools for authenticating via OAuth 2.0 |
|
|
|
Do the OAuth 2.0 Web Server dance for a command line application. Stores the |
|
generated credentials in a common file that is used by other example apps in |
|
the same directory. |
|
""" |
|
|
|
__author__ = '[email protected] (Joe Gregorio)' |
|
__all__ = ['run'] |
|
|
|
|
|
import BaseHTTPServer |
|
import gflags |
|
import logging |
|
import socket |
|
import sys |
|
|
|
from optparse import OptionParser |
|
from client import FlowExchangeError |
|
|
|
try: |
|
from urlparse import parse_qsl |
|
except ImportError: |
|
from cgi import parse_qsl |
|
|
|
|
|
FLAGS = gflags.FLAGS |
|
|
|
gflags.DEFINE_boolean('auth_local_webserver', True, |
|
('Run a local web server to handle redirects during ' |
|
'OAuth authorization.')) |
|
|
|
gflags.DEFINE_string('auth_host_name', 'localhost', |
|
('Host name to use when running a local web server to ' |
|
'handle redirects during OAuth authorization.')) |
|
|
|
gflags.DEFINE_multi_int('auth_host_port', [8080, 8090], |
|
('Port to use when running a local web server to ' |
|
'handle redirects during OAuth authorization.')) |
|
|
|
|
|
class ClientRedirectServer(BaseHTTPServer.HTTPServer): |
|
"""A server to handle OAuth 2.0 redirects back to localhost. |
|
|
|
Waits for a single request and parses the query parameters |
|
into query_params and then stops serving. |
|
""" |
|
query_params = {} |
|
|
|
|
|
class ClientRedirectHandler(BaseHTTPServer.BaseHTTPRequestHandler): |
|
"""A handler for OAuth 2.0 redirects back to localhost. |
|
|
|
Waits for a single request and parses the query parameters |
|
into the servers query_params and then stops serving. |
|
""" |
|
|
|
def do_GET(s): |
|
"""Handle a GET request |
|
|
|
Parses the query parameters and prints a message |
|
if the flow has completed. Note that we can't detect |
|
if an error occurred. |
|
""" |
|
s.send_response(200) |
|
s.send_header("Content-type", "text/html") |
|
s.end_headers() |
|
query = s.path.split('?', 1)[-1] |
|
query = dict(parse_qsl(query)) |
|
s.server.query_params = query |
|
s.wfile.write("<html><head><title>Authentication Status</title></head>") |
|
s.wfile.write("<body><p>The authentication flow has completed.</p>") |
|
s.wfile.write("</body></html>") |
|
|
|
def log_message(self, format, *args): |
|
"""Do not log messages to stdout while running as command line program.""" |
|
pass |
|
|
|
|
|
def run(flow, storage): |
|
"""Core code for a command-line application. |
|
|
|
Args: |
|
flow: Flow, an OAuth 2.0 Flow to step through. |
|
storage: Storage, a Storage to store the credential in. |
|
|
|
Returns: |
|
Credentials, the obtained credential. |
|
""" |
|
if FLAGS.auth_local_webserver: |
|
success = False |
|
port_number = 0 |
|
for port in FLAGS.auth_host_port: |
|
port_number = port |
|
try: |
|
httpd = BaseHTTPServer.HTTPServer((FLAGS.auth_host_name, port), |
|
ClientRedirectHandler) |
|
except socket.error, e: |
|
pass |
|
else: |
|
success = True |
|
break |
|
FLAGS.auth_local_webserver = success |
|
|
|
if FLAGS.auth_local_webserver: |
|
oauth_callback = 'http://%s:%s/' % (FLAGS.auth_host_name, port_number) |
|
else: |
|
oauth_callback = 'oob' |
|
authorize_url = flow.step1_get_authorize_url(oauth_callback) |
|
|
|
print 'Go to the following link in your browser:' |
|
print authorize_url |
|
print |
|
|
|
if FLAGS.auth_local_webserver: |
|
httpd.handle_request() |
|
if 'error' in httpd.query_params: |
|
sys.exit('Authentication request was rejected.') |
|
if 'code' in httpd.query_params: |
|
code = httpd.query_params['code'] |
|
else: |
|
accepted = 'n' |
|
while accepted.lower() == 'n': |
|
accepted = raw_input('Have you authorized me? (y/n) ') |
|
code = raw_input('What is the verification code? ').strip() |
|
|
|
try: |
|
credentials = flow.step2_exchange(code) |
|
except FlowExchangeError: |
|
sys.exit('The authentication has failed.') |
|
|
|
storage.put(credentials) |
|
credentials.set_store(storage.put) |
|
print "You have successfully authenticated." |
|
|
|
return credentials |