OLD | NEW |
(Empty) | |
| 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 |
| 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. |
| 20 """ |
| 21 |
| 22 __author__ = 'jcgregorio@google.com (Joe Gregorio)' |
| 23 __all__ = ['run'] |
| 24 |
| 25 |
| 26 import BaseHTTPServer |
| 27 import gflags |
| 28 import socket |
| 29 import sys |
| 30 import webbrowser |
| 31 |
| 32 from client import FlowExchangeError |
| 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 |
| 93 def run(flow, storage): |
| 94 """Core code for a command-line application. |
| 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. |
| 102 """ |
| 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 = ClientRedirectServer((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) |
| 123 |
| 124 if FLAGS.auth_local_webserver: |
| 125 webbrowser.open(authorize_url, new=1, autoraise=True) |
| 126 print 'Your browser has been opened to visit:' |
| 127 print |
| 128 print ' ' + authorize_url |
| 129 print |
| 130 print 'If your browser is on a different machine then exit and re-run this' |
| 131 print 'application with the command-line parameter ' |
| 132 print |
| 133 print ' --noauth_local_webserver' |
| 134 print |
| 135 else: |
| 136 print 'Go to the following link in your browser:' |
| 137 print |
| 138 print ' ' + authorize_url |
| 139 print |
| 140 |
| 141 code = None |
| 142 if FLAGS.auth_local_webserver: |
| 143 httpd.handle_request() |
| 144 if 'error' in httpd.query_params: |
| 145 sys.exit('Authentication request was rejected.') |
| 146 if 'code' in httpd.query_params: |
| 147 code = httpd.query_params['code'] |
| 148 else: |
| 149 print 'Failed to find "code" in the query parameters of the redirect.' |
| 150 sys.exit('Try running with --noauth_local_webserver.') |
| 151 else: |
| 152 code = raw_input('Enter verification code: ').strip() |
| 153 |
| 154 try: |
| 155 credential = flow.step2_exchange(code) |
| 156 except FlowExchangeError, e: |
| 157 sys.exit('Authentication has failed: %s' % e) |
| 158 |
| 159 storage.put(credential) |
| 160 credential.set_store(storage) |
| 161 print 'Authentication successful.' |
| 162 |
| 163 return credential |
OLD | NEW |