Blame - oauth2client/tools.py - platform/external/python/google-api-python-client

blob: f04d4c80cf428ac18eff8cbec1cf9dd0e5da0dd1 [file] [log] [blame]

Joe Gregorio	695fdc1	2011-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 Gregorio	7c22ab2	2011-02-16 15:32:39 -0500	[diff] [blame]	17	Do the OAuth 2.0 Web Server dance for a command line application. Stores the
				18	generated credentials in a common file that is used by other example apps in
				19	the same directory.
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	20	"""
				21
				22	__author__ = 'jcgregorio@google.com (Joe Gregorio)'
Joe Gregorio	7c22ab2	2011-02-16 15:32:39 -0500	[diff] [blame]	23	__all__ = ['run']
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	24
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	25
Joe Gregorio	9e5fe4d	2011-03-10 09:33:47 -0500	[diff] [blame]	26	import BaseHTTPServer
				27	import gflags
				28	import logging
				29	import socket
				30	import sys
				31
Joe Gregorio	06d852b	2011-03-25 15:03:10 -0400	[diff] [blame]	32	from client import FlowExchangeError
Joe Gregorio	9e5fe4d	2011-03-10 09:33:47 -0500	[diff] [blame]	33
				34	try:
				35	from urlparse import parse_qsl
				36	except ImportError:
				37	from cgi import parse_qsl
				38
				39
				40	FLAGS = gflags.FLAGS
				41
				42	gflags.DEFINE_boolean('auth_local_webserver', True,
				43	('Run a local web server to handle redirects during '
				44	'OAuth authorization.'))
				45
				46	gflags.DEFINE_string('auth_host_name', 'localhost',
				47	('Host name to use when running a local web server to '
				48	'handle redirects during OAuth authorization.'))
				49
				50	gflags.DEFINE_multi_int('auth_host_port', [8080, 8090],
				51	('Port to use when running a local web server to '
				52	'handle redirects during OAuth authorization.'))
				53
				54
				55	class ClientRedirectServer(BaseHTTPServer.HTTPServer):
				56	"""A server to handle OAuth 2.0 redirects back to localhost.
				57
				58	Waits for a single request and parses the query parameters
				59	into query_params and then stops serving.
				60	"""
				61	query_params = {}
				62
				63
				64	class ClientRedirectHandler(BaseHTTPServer.BaseHTTPRequestHandler):
				65	"""A handler for OAuth 2.0 redirects back to localhost.
				66
				67	Waits for a single request and parses the query parameters
				68	into the servers query_params and then stops serving.
				69	"""
				70
				71	def do_GET(s):
				72	"""Handle a GET request
				73
				74	Parses the query parameters and prints a message
				75	if the flow has completed. Note that we can't detect
				76	if an error occurred.
				77	"""
				78	s.send_response(200)
				79	s.send_header("Content-type", "text/html")
				80	s.end_headers()
				81	query = s.path.split('?', 1)[-1]
				82	query = dict(parse_qsl(query))
				83	s.server.query_params = query
				84	s.wfile.write("<html><head><title>Authentication Status</title></head>")
				85	s.wfile.write("<body><p>The authentication flow has completed.</p>")
				86	s.wfile.write("</body></html>")
				87
				88	def log_message(self, format, *args):
				89	"""Do not log messages to stdout while running as command line program."""
				90	pass
				91
				92
Joe Gregorio	deeb020	2011-02-15 14:49:57 -0500	[diff] [blame]	93	def run(flow, storage):
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	94	"""Core code for a command-line application.
Joe Gregorio	fffa7d7	2011-02-18 17:20:39 -0500	[diff] [blame]	95
				96	Args:
				97	flow: Flow, an OAuth 2.0 Flow to step through.
				98	storage: Storage, a Storage to store the credential in.
				99
				100	Returns:
				101	Credentials, the obtained credential.
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	102	"""
Joe Gregorio	9e5fe4d	2011-03-10 09:33:47 -0500	[diff] [blame]	103	if FLAGS.auth_local_webserver:
				104	success = False
				105	port_number = 0
				106	for port in FLAGS.auth_host_port:
				107	port_number = port
				108	try:
				109	httpd = BaseHTTPServer.HTTPServer((FLAGS.auth_host_name, port),
				110	ClientRedirectHandler)
				111	except socket.error, e:
				112	pass
				113	else:
				114	success = True
				115	break
				116	FLAGS.auth_local_webserver = success
				117
				118	if FLAGS.auth_local_webserver:
				119	oauth_callback = 'http://%s:%s/' % (FLAGS.auth_host_name, port_number)
				120	else:
				121	oauth_callback = 'oob'
				122	authorize_url = flow.step1_get_authorize_url(oauth_callback)
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	123
				124	print 'Go to the following link in your browser:'
				125	print authorize_url
				126	print
Joe Gregorio	8097e2a	2011-05-17 11:11:34 -0400	[diff] [blame]	127	if FLAGS.auth_local_webserver:
				128	print 'If your browser is on a different machine then exit and re-run this'
				129	print 'application with the command-line parameter --noauth_local_webserver.'
				130	print
				131
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	132
Joe Gregorio	9e5fe4d	2011-03-10 09:33:47 -0500	[diff] [blame]	133	if FLAGS.auth_local_webserver:
				134	httpd.handle_request()
				135	if 'error' in httpd.query_params:
				136	sys.exit('Authentication request was rejected.')
				137	if 'code' in httpd.query_params:
				138	code = httpd.query_params['code']
				139	else:
				140	accepted = 'n'
				141	while accepted.lower() == 'n':
				142	accepted = raw_input('Have you authorized me? (y/n) ')
				143	code = raw_input('What is the verification code? ').strip()
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	144
Joe Gregorio	fffa7d7	2011-02-18 17:20:39 -0500	[diff] [blame]	145	try:
				146	credentials = flow.step2_exchange(code)
Joe Gregorio	06d852b	2011-03-25 15:03:10 -0400	[diff] [blame]	147	except FlowExchangeError:
Joe Gregorio	fffa7d7	2011-02-18 17:20:39 -0500	[diff] [blame]	148	sys.exit('The authentication has failed.')
Joe Gregorio	695fdc1	2011-01-16 16:46:55 -0500	[diff] [blame]	149
Joe Gregorio	deeb020	2011-02-15 14:49:57 -0500	[diff] [blame]	150	storage.put(credentials)
				151	credentials.set_store(storage.put)
Joe Gregorio	9e5fe4d	2011-03-10 09:33:47 -0500	[diff] [blame]	152	print "You have successfully authenticated."
Joe Gregorio	deeb020	2011-02-15 14:49:57 -0500	[diff] [blame]	153
				154	return credentials