Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 88f699fb5f9e356cdd78bcab588f8f3e1aa53921 / . / oauth2client / tools.py
blob: eeb90318474cf70c775d05420e453e46a967a659 [file] [log] [blame]
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]1# Copyright (C) 2010 Google Inc.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15"""Command-line tools for authenticating via OAuth 2.0
16
Joe Gregorio7c22ab22011-02-16 15:32:39 -0500[diff] [blame]17Do the OAuth 2.0 Web Server dance for a command line application. Stores the
18generated credentials in a common file that is used by other example apps in
19the same directory.
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]20"""
21
22__author__ = 'jcgregorio@google.com (Joe Gregorio)'
Joe Gregorio7c22ab22011-02-16 15:32:39 -0500[diff] [blame]23__all__ = ['run']
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]24
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]25
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]26import BaseHTTPServer
27import gflags
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]28import socket
29import sys
Joe Gregorio2fdd2952012-01-17 09:03:28 -0500[diff] [blame]30import webbrowser
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]31
Joe Gregorio06d852b2011-03-25 15:03:10 -0400[diff] [blame]32from client import FlowExchangeError
Joe Gregoriof2326c02012-02-09 12:18:44 -0500[diff] [blame]33from client import OOB_CALLBACK_URN
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]34
35try:
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]36 from urlparse import parse_qsl
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]37except ImportError:
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]38 from cgi import parse_qsl
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]39
40
41FLAGS = gflags.FLAGS
42
43gflags.DEFINE_boolean('auth_local_webserver', True,
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]44 ('Run a local web server to handle redirects during '
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]45 'OAuth authorization.'))
46
47gflags.DEFINE_string('auth_host_name', 'localhost',
48 ('Host name to use when running a local web server to '
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]49 'handle redirects during OAuth authorization.'))
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]50
51gflags.DEFINE_multi_int('auth_host_port', [8080, 8090],
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]52 ('Port to use when running a local web server to '
53 'handle redirects during OAuth authorization.'))
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]54
55
56class ClientRedirectServer(BaseHTTPServer.HTTPServer):
57 """A server to handle OAuth 2.0 redirects back to localhost.
58
59 Waits for a single request and parses the query parameters
60 into query_params and then stops serving.
61 """
62 query_params = {}
63
64
65class ClientRedirectHandler(BaseHTTPServer.BaseHTTPRequestHandler):
66 """A handler for OAuth 2.0 redirects back to localhost.
67
68 Waits for a single request and parses the query parameters
69 into the servers query_params and then stops serving.
70 """
71
72 def do_GET(s):
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]73 """Handle a GET request.
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]74
75 Parses the query parameters and prints a message
76 if the flow has completed. Note that we can't detect
77 if an error occurred.
78 """
79 s.send_response(200)
80 s.send_header("Content-type", "text/html")
81 s.end_headers()
82 query = s.path.split('?', 1)[-1]
83 query = dict(parse_qsl(query))
84 s.server.query_params = query
85 s.wfile.write("<html><head><title>Authentication Status</title></head>")
86 s.wfile.write("<body><p>The authentication flow has completed.</p>")
87 s.wfile.write("</body></html>")
88
89 def log_message(self, format, *args):
90 """Do not log messages to stdout while running as command line program."""
91 pass
92
93
Joe Gregorio8e000ed2012-02-07 15:41:44 -0500[diff] [blame]94def run(flow, storage, http=None):
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]95 """Core code for a command-line application.
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame]96
97 Args:
98 flow: Flow, an OAuth 2.0 Flow to step through.
99 storage: Storage, a Storage to store the credential in.
Joe Gregorio8e000ed2012-02-07 15:41:44 -0500[diff] [blame]100 http: An instance of httplib2.Http.request
101 or something that acts like it.
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame]102
103 Returns:
104 Credentials, the obtained credential.
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]105 """
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]106 if FLAGS.auth_local_webserver:
107 success = False
108 port_number = 0
109 for port in FLAGS.auth_host_port:
110 port_number = port
111 try:
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]112 httpd = ClientRedirectServer((FLAGS.auth_host_name, port),
113 ClientRedirectHandler)
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]114 except socket.error, e:
115 pass
116 else:
117 success = True
118 break
119 FLAGS.auth_local_webserver = success
120
121 if FLAGS.auth_local_webserver:
122 oauth_callback = 'http://%s:%s/' % (FLAGS.auth_host_name, port_number)
123 else:
Joe Gregoriof2326c02012-02-09 12:18:44 -0500[diff] [blame]124 oauth_callback = OOB_CALLBACK_URN
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]125 authorize_url = flow.step1_get_authorize_url(oauth_callback)
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]126
Joe Gregorio8097e2a2011-05-17 11:11:34 -0400[diff] [blame]127 if FLAGS.auth_local_webserver:
Joe Gregorio2fdd2952012-01-17 09:03:28 -0500[diff] [blame]128 webbrowser.open(authorize_url, new=1, autoraise=True)
129 print 'Your browser has been opened to visit:'
130 print
131 print ' ' + authorize_url
132 print
Joe Gregorio8097e2a2011-05-17 11:11:34 -0400[diff] [blame]133 print 'If your browser is on a different machine then exit and re-run this'
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]134 print 'application with the command-line parameter '
Joe Gregorio2fdd2952012-01-17 09:03:28 -0500[diff] [blame]135 print
136 print ' --noauth_local_webserver'
137 print
138 else:
139 print 'Go to the following link in your browser:'
140 print
141 print ' ' + authorize_url
Joe Gregorio8097e2a2011-05-17 11:11:34 -0400[diff] [blame]142 print
143
Joe Gregorio562b7312011-09-15 09:06:38 -0400[diff] [blame]144 code = None
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]145 if FLAGS.auth_local_webserver:
146 httpd.handle_request()
147 if 'error' in httpd.query_params:
148 sys.exit('Authentication request was rejected.')
149 if 'code' in httpd.query_params:
150 code = httpd.query_params['code']
Joe Gregorio562b7312011-09-15 09:06:38 -0400[diff] [blame]151 else:
152 print 'Failed to find "code" in the query parameters of the redirect.'
153 sys.exit('Try running with --noauth_local_webserver.')
Joe Gregorio9e5fe4d2011-03-10 09:33:47 -0500[diff] [blame]154 else:
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]155 code = raw_input('Enter verification code: ').strip()
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]156
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame]157 try:
Joe Gregorio8e000ed2012-02-07 15:41:44 -0500[diff] [blame]158 credential = flow.step2_exchange(code, http)
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]159 except FlowExchangeError, e:
160 sys.exit('Authentication has failed: %s' % e)
Joe Gregorio695fdc12011-01-16 16:46:55 -0500[diff] [blame]161
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]162 storage.put(credential)
163 credential.set_store(storage)
164 print 'Authentication successful.'
Joe Gregoriodeeb0202011-02-15 14:49:57 -0500[diff] [blame]165
Joe Gregorio9da2ad82011-09-11 14:04:44 -0400[diff] [blame]166 return credential