gclientid 0.1.0__tar.gz

gclientid-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+<!-- do not remove -->
+
+## 0.1.0
+
+### New Features
+
+- Require fastcdp 0.0.8 ([#6](https://github.com/AnswerDotAI/gclientid/pull/6)), thanks to [@jph00](https://github.com/jph00)
+- Use normal Chrome by default ([#5](https://github.com/AnswerDotAI/gclientid/pull/5)), thanks to [@jph00](https://github.com/jph00)
+- Create local Gmail OAuth credential files ([#4](https://github.com/AnswerDotAI/gclientid/pull/4)), thanks to [@jph00](https://github.com/jph00)
+- Document personal Gmail OAuth setup ([#3](https://github.com/AnswerDotAI/gclientid/pull/3)), thanks to [@jph00](https://github.com/jph00)
+- Publish the privacy policy with GitHub Pages ([#2](https://github.com/AnswerDotAI/gclientid/pull/2)), thanks to [@jph00](https://github.com/jph00)
+- Add Google Cloud project lifecycle automation ([#1](https://github.com/AnswerDotAI/gclientid/pull/1)), thanks to [@jph00](https://github.com/jph00)

gclientid-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

gclientid-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+include CHANGELOG.md

gclientid-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: gclientid
+Version: 0.1.0
+Summary: Create Google OAuth desktop client IDs locally
+Author-email: Jeremy Howard <github@jhoward.fastmail.fm>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/AnswerDotAI/gclientid
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcdp>=0.0.8
+Requires-Dist: httpx
+Provides-Extra: dev
+Requires-Dist: fastship; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# gclientid
+
+Create Google OAuth desktop client IDs locally, without requiring `gcloud`.
+
+`gclientid` uses an existing signed-in [fastcdp](https://github.com/AnswerDotAI/fastcdp) Chrome session. Enable **Allow remote debugging** in `chrome://inspect/#remote-debugging`, then create a globally unique project ID, provision its Gmail Desktop OAuth client, and authorize the Gmail account:
+
+```python
+from gclientid import authorize_gmail, connect_browser, create_gmail_client, create_project
+
+cdp, page = await connect_browser()
+project_id = 'gclientids-your-unique-suffix'
+
+await create_project(page, project_id, name='gclientids')
+await create_gmail_client(page, project_id, 'oauth-client.json')
+await authorize_gmail(cdp, 'oauth-client.json', 'oauth-token.json')
+```
+
+`connect_browser()` uses the normal Chrome profile by default. Chrome gives you 60 seconds to approve the debugging connection. The function opens a new tab instead of navigating the currently focused tab. To use the separate CDP Chrome profile on port 9223 instead:
+
+```python
+cdp, page = await connect_browser(default_browser=False)
+```
+
+`create_gmail_client` enables the Gmail API, configures an External OAuth application, adds the full Gmail scope, publishes the unverified application, creates a Desktop client, and writes Google's installed-app client JSON. It selects an email offered by the signed-in Google account for the support and contact fields. It does not require an email or username argument.
+
+On a new Google Auth Platform application, `create_gmail_client` pauses at Google's API Services terms screen. Complete that visible screen in Chrome and the function continues. Pass `accept_terms=True` to accept and submit that screen automatically:
+
+```python
+await create_gmail_client(page, project_id, 'oauth-client.json', accept_terms=True)
+```
+
+`authorize_gmail` opens Google's account and consent screens in a new Chrome tab. It selects the account automatically when Google offers one existing account, then approves the requested Gmail access. When Google offers multiple existing accounts, select one by display name or email substring:
+
+```python
+await authorize_gmail(cdp, 'oauth-client.json', 'oauth-token.json', account='j@example.com')
+```
+
+The function uses a PKCE loopback flow and writes the access token, refresh token, granted scope, client ID, and creation time to `oauth-token.json`.
+
+Both JSON files are created with mode `0600`. `create_gmail_client` refuses to overwrite an existing client file because Google only exposes the Desktop client secret at creation time. `authorize_gmail` replaces the token file when authorization succeeds. Keep both files out of git.
+
+Project deletion is also available. Google keeps a deleted project recoverable for 30 days:
+
+```python
+from gclientid import delete_project
+
+await delete_project(page, project_id)
+```
+
+See the [privacy policy](PRIVACY.md) for how Google user data is handled.
+
+## Personal OAuth applications
+
+The intended setup is one Google Cloud project and Desktop OAuth client per
+developer. Configure its audience as **External**, publish it **In production**,
+and leave it unverified. Google may say that the app "requires verification",
+but personal-use applications can still authorize up to 100 distinct users.
+Users see an unverified-app warning during initial authorization; verification
+is only needed to remove that warning or exceed the lifetime user cap.
+
+Do not leave a continuously running application in **Testing**. Testing requires
+an explicit test-user email list, and authorizations requesting Gmail access
+expire after seven days. An unverified app that is In production needs neither
+the allowlist nor seven-day reauthorization.
+
+The unrestricted Gmail scope is `https://mail.google.com/`. It is a restricted
+scope and allows reading, composing, sending, and permanently deleting mail.
+The application must request this scope during authorization even when it is
+already listed on the Google Auth Platform Data Access page.
+
+Google currently requires a Desktop client's `client_secret` during the token
+exchange, including when PKCE is used. The secret is shown only when the client
+is created, so capture or download the client JSON immediately. Desktop software
+cannot keep this value confidential, but it must still be kept out of git along
+with user access and refresh tokens.
+
+## Development
+
+```bash
+pip install -e .[dev]
+```
+
+## Versioning
+
+Version lives in `gclientid/__init__.py` as `__version__`.
+Bump it with:
+
+```bash
+ship-bump --part 2   # patch
+ship-bump --part 1   # minor
+ship-bump --part 0   # major
+```
+
+## Release
+
+1) Ensure your GitHub issues are labeled (`bug`, `enhancement`, `breaking`).
+2) Run:
+
+```bash
+ship-release
+```

gclientid-0.1.0/README.md

@@ -0,0 +1,101 @@
+# gclientid
+
+Create Google OAuth desktop client IDs locally, without requiring `gcloud`.
+
+`gclientid` uses an existing signed-in [fastcdp](https://github.com/AnswerDotAI/fastcdp) Chrome session. Enable **Allow remote debugging** in `chrome://inspect/#remote-debugging`, then create a globally unique project ID, provision its Gmail Desktop OAuth client, and authorize the Gmail account:
+
+```python
+from gclientid import authorize_gmail, connect_browser, create_gmail_client, create_project
+
+cdp, page = await connect_browser()
+project_id = 'gclientids-your-unique-suffix'
+
+await create_project(page, project_id, name='gclientids')
+await create_gmail_client(page, project_id, 'oauth-client.json')
+await authorize_gmail(cdp, 'oauth-client.json', 'oauth-token.json')
+```
+
+`connect_browser()` uses the normal Chrome profile by default. Chrome gives you 60 seconds to approve the debugging connection. The function opens a new tab instead of navigating the currently focused tab. To use the separate CDP Chrome profile on port 9223 instead:
+
+```python
+cdp, page = await connect_browser(default_browser=False)
+```
+
+`create_gmail_client` enables the Gmail API, configures an External OAuth application, adds the full Gmail scope, publishes the unverified application, creates a Desktop client, and writes Google's installed-app client JSON. It selects an email offered by the signed-in Google account for the support and contact fields. It does not require an email or username argument.
+
+On a new Google Auth Platform application, `create_gmail_client` pauses at Google's API Services terms screen. Complete that visible screen in Chrome and the function continues. Pass `accept_terms=True` to accept and submit that screen automatically:
+
+```python
+await create_gmail_client(page, project_id, 'oauth-client.json', accept_terms=True)
+```
+
+`authorize_gmail` opens Google's account and consent screens in a new Chrome tab. It selects the account automatically when Google offers one existing account, then approves the requested Gmail access. When Google offers multiple existing accounts, select one by display name or email substring:
+
+```python
+await authorize_gmail(cdp, 'oauth-client.json', 'oauth-token.json', account='j@example.com')
+```
+
+The function uses a PKCE loopback flow and writes the access token, refresh token, granted scope, client ID, and creation time to `oauth-token.json`.
+
+Both JSON files are created with mode `0600`. `create_gmail_client` refuses to overwrite an existing client file because Google only exposes the Desktop client secret at creation time. `authorize_gmail` replaces the token file when authorization succeeds. Keep both files out of git.
+
+Project deletion is also available. Google keeps a deleted project recoverable for 30 days:
+
+```python
+from gclientid import delete_project
+
+await delete_project(page, project_id)
+```
+
+See the [privacy policy](PRIVACY.md) for how Google user data is handled.
+
+## Personal OAuth applications
+
+The intended setup is one Google Cloud project and Desktop OAuth client per
+developer. Configure its audience as **External**, publish it **In production**,
+and leave it unverified. Google may say that the app "requires verification",
+but personal-use applications can still authorize up to 100 distinct users.
+Users see an unverified-app warning during initial authorization; verification
+is only needed to remove that warning or exceed the lifetime user cap.
+
+Do not leave a continuously running application in **Testing**. Testing requires
+an explicit test-user email list, and authorizations requesting Gmail access
+expire after seven days. An unverified app that is In production needs neither
+the allowlist nor seven-day reauthorization.
+
+The unrestricted Gmail scope is `https://mail.google.com/`. It is a restricted
+scope and allows reading, composing, sending, and permanently deleting mail.
+The application must request this scope during authorization even when it is
+already listed on the Google Auth Platform Data Access page.
+
+Google currently requires a Desktop client's `client_secret` during the token
+exchange, including when PKCE is used. The secret is shown only when the client
+is created, so capture or download the client JSON immediately. Desktop software
+cannot keep this value confidential, but it must still be kept out of git along
+with user access and refresh tokens.
+
+## Development
+
+```bash
+pip install -e .[dev]
+```
+
+## Versioning
+
+Version lives in `gclientid/__init__.py` as `__version__`.
+Bump it with:
+
+```bash
+ship-bump --part 2   # patch
+ship-bump --part 1   # minor
+ship-bump --part 0   # major
+```
+
+## Release
+
+1) Ensure your GitHub issues are labeled (`bug`, `enhancement`, `breaking`).
+2) Run:
+
+```bash
+ship-release
+```

gclientid-0.1.0/gclientid/__init__.py

@@ -0,0 +1,4 @@
+__version__ = "0.1.0"
+
+from .projects import create_project, delete_project
+from .oauth import GMAIL_SCOPE, authorize_gmail, connect_browser, create_gmail_client

gclientid-0.1.0/gclientid/oauth.py

@@ -0,0 +1,245 @@
+import asyncio, base64, hashlib, json, os, secrets
+from datetime import datetime, timezone
+from pathlib import Path
+from urllib.parse import parse_qs, urlencode, urlparse
+
+import httpx
+from fastcdp import CDP, Page
+
+
+GMAIL_SCOPE = 'https://mail.google.com/'
+HOME_URL = 'https://answerdotai.github.io/gclientid/'
+PRIVACY_URL = f'{HOME_URL}privacy/'
+DOMAIN = 'answerdotai.github.io'
+AUTH_URI = 'https://accounts.google.com/o/oauth2/auth'
+TOKEN_URI = 'https://oauth2.googleapis.com/token'
+CERT_URI = 'https://www.googleapis.com/oauth2/v1/certs'
+
+
+async def connect_browser(
+    default_browser:bool=True, # Use normal Chrome instead of CDP Chrome?
+    timeout:int=60, # Seconds to wait for normal Chrome's approval
+) -> tuple[CDP, Page]:
+    "Connect to Chrome and return its connection and a new page"
+    try: cdp = await (CDP.connect(timeout=timeout) if default_browser else CDP.remote())
+    except FileNotFoundError: raise RuntimeError('Enable Allow remote debugging in chrome://inspect/#remote-debugging, then retry') from None
+    return cdp, await cdp.new_page()
+
+
+def _write_json(path:str|Path, data:dict) -> Path:
+    "Write private JSON and return its path"
+    path = Path(path)
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(json.dumps(data, indent=2) + '\n')
+    os.chmod(path, 0o600)
+    return path
+
+
+async def _enable_gmail(page:Page, project_id:str, timeout:int):
+    url = f'https://console.cloud.google.com/apis/library/gmail.googleapis.com?project={project_id}'
+    await page.goto(url, timeout=timeout)
+    tree = await page.wait_for_ax('heading', 'Gmail API', timeout=timeout)
+    enable = tree.find('button', 'enable this API')
+    if enable:
+        await page.click(enable.find_id())
+        await page.wait_for_ax('button', 'Disable API', timeout=timeout)
+
+
+async def _setup_auth(page:Page, project_id:str, name:str, accept_terms:bool, timeout:int, terms_timeout:int):
+    await page.goto(f'https://console.cloud.google.com/auth/overview?project={project_id}', timeout=timeout)
+    tree = await page.ax_tree()
+    start = tree.find('link', 'Get started')
+    if not start: return
+
+    await page.click(start.find_id())
+    tree = await page.wait_for_ax('heading', 'App Information', timeout=timeout)
+    await page.fill_text(tree.find_id('textbox', 'App name'), name)
+    await page.wait_for(r'''[...document.querySelectorAll('[role="combobox"]')].some(
+        x => x.getAttribute('aria-label') === 'User support email' && x.getAttribute('aria-disabled') !== 'true')''', timeout=timeout)
+    tree = await page.ax_tree()
+    await page.click(tree.find_id('combobox', 'User support email'))
+    tree = await page.wait_for_ax('option', timeout=timeout)
+    email = next((n.name for n in tree.find_all('option') if '@' in n.name), None)
+    if not email: raise RuntimeError('Google did not offer a support email')
+    await page.click(tree.find_id('option', email))
+
+    tree = await page.ax_tree()
+    await page.click(tree.find('main').find('form').find_id('button', 'Next'))
+    tree = await page.wait_for_ax('heading', 'Audience, step 2 of 4, in progress', timeout=timeout)
+    await page.click(tree.find('main').find('form').find_id('radio', 'External'))
+    tree = await page.ax_tree()
+    await page.click(tree.find('main').find('form').find_id('button', 'Next'))
+
+    tree = await page.wait_for_ax('heading', 'Contact Information, step 3 of 4, in progress', timeout=timeout)
+    contact = tree.find('main').find('form').find_id('textbox', 'Text field for emails')
+    await page.fill_text(contact, email)
+    await page.input.dispatchKeyEvent(type='rawKeyDown', key='Enter', code='Enter', windowsVirtualKeyCode=13)
+    await page.input.dispatchKeyEvent(type='keyUp', key='Enter', code='Enter', windowsVirtualKeyCode=13)
+    tree = await page.ax_tree()
+    await page.click(tree.find('main').find('form').find_id('button', 'Next'))
+
+    tree = await page.wait_for_ax('heading', 'Finish, step 4 of 4, in progress', timeout=timeout)
+    if accept_terms:
+        await page.click(tree.find('main').find('form').find_id('checkbox', 'I agree'))
+        tree = await page.ax_tree()
+        await page.click(tree.find('main').find('form').find_id('button', 'Continue'))
+        tree = await page.wait_for_ax('button', 'Create', timeout=timeout)
+        await page.click(tree.find('main').find('form').find_id('button', 'Create'))
+    await page.wait_for_ax('heading', 'OAuth Overview', timeout=terms_timeout)
+
+
+async def _set_branding(page:Page, project_id:str, timeout:int):
+    await page.goto(f'https://console.cloud.google.com/auth/branding?project={project_id}', timeout=timeout)
+    tree = await page.wait_for_ax('heading', 'Branding', timeout=timeout)
+    await page.fill_text(tree.find_id('textbox', 'Application home page'), HOME_URL)
+    await page.fill_text(tree.find_id('textbox', 'Application privacy policy link'), PRIVACY_URL)
+    tree = await page.ax_tree()
+    if not tree.find(name=DOMAIN):
+        domains = tree.find('main').find('form').find_all('textbox', 'Authorized domain')
+        if not domains:
+            await page.click(tree.find_id('button', 'Add domain'))
+            tree = await page.wait_for_ax('textbox', 'Authorized domain', timeout=timeout)
+            domains = tree.find('main').find('form').find_all('textbox', 'Authorized domain')
+        await page.fill_text(domains[-1].find_id(), DOMAIN)
+        tree = await page.ax_tree()
+    await page.click(tree.find('main').find('form').find_id('button', 'Save'))
+    await page.wait_for_ready(timeout=timeout)
+    if (await page.ax_tree()).find('dialog', 'Error dialog'): raise RuntimeError('Google rejected the OAuth branding settings')
+
+
+async def _set_scope(page:Page, project_id:str, timeout:int):
+    await page.goto(f'https://console.cloud.google.com/auth/scopes?project={project_id}', timeout=timeout)
+    tree = await page.wait_for_ax('heading', 'Data Access', timeout=timeout)
+    if any(GMAIL_SCOPE in n.name.replace(' ', '') for n in tree.find_all('row')): return
+    await page.click(tree.find_id('button', 'Add or remove scopes'))
+    tree = await page.wait_for_ax('dialog', 'Update selected scopes', timeout=timeout)
+    dialog = tree.find('dialog', 'Update selected scopes')
+    await page.fill_text(dialog.find_id('textbox', 'Manually paste scopes'), GMAIL_SCOPE)
+    tree = await page.ax_tree()
+    await page.click(tree.find('dialog', 'Update selected scopes').find_id('button', 'Add to table'))
+    tree = await page.wait_for_ax('row', 'https://mail', timeout=timeout)
+    await page.click(tree.find('dialog', 'Update selected scopes').find_id('button', 'Update'))
+    await page.wait_for_text('Update selected scopes', present=False, timeout=timeout)
+    tree = await page.ax_tree()
+    await page.click(tree.find('main').find('form').find_id('button', 'Save'))
+    await page.wait_for_ready(timeout=timeout)
+
+
+async def _publish(page:Page, project_id:str, timeout:int):
+    await page.goto(f'https://console.cloud.google.com/auth/audience?project={project_id}', timeout=timeout)
+    tree = await page.wait_for_ax('heading', 'Audience', timeout=timeout)
+    if tree.find(name='In production'): return
+    await page.click(tree.find_id('button', 'Publish app'))
+    tree = await page.wait_for_ax('alertdialog', 'Push to production?', timeout=timeout)
+    await page.click(tree.find('alertdialog', 'Push to production?').find_id('button', 'Confirm'))
+    await page.wait_for_ax(name='In production', timeout=timeout)
+
+
+async def create_gmail_client(
+    page:Page, # Signed-in Google Cloud Console page
+    project_id:str, # Existing Google Cloud project ID
+    path:str|Path='oauth-client.json', # Destination for Google's installed-app client JSON
+    name:str='gclientids', # OAuth application and Desktop client name
+    accept_terms:bool=False, # Accept Google's API Services terms without pausing?
+    timeout:int=60, # Seconds to wait for each Console operation
+    terms_timeout:int=600, # Seconds to wait while the developer handles the terms screen
+) -> dict:
+    "Configure Gmail OAuth, create a Desktop client, and save its client JSON"
+    path = Path(path)
+    if path.exists(): raise FileExistsError(path)
+    await _enable_gmail(page, project_id, timeout)
+    await _setup_auth(page, project_id, name, accept_terms, timeout, terms_timeout)
+    await _set_branding(page, project_id, timeout)
+    await _set_scope(page, project_id, timeout)
+    await _publish(page, project_id, timeout)
+
+    await page.goto(f'https://console.cloud.google.com/auth/clients/create?project={project_id}', timeout=timeout)
+    tree = await page.wait_for_ax('heading', 'Create OAuth client ID', timeout=timeout)
+    await page.click(tree.find_id('combobox', 'Application type'))
+    tree = await page.wait_for_ax('option', 'Desktop app', timeout=timeout)
+    await page.click(tree.find_id('option', 'Desktop app'))
+    tree = await page.wait_for_ax('textbox', 'Name', timeout=timeout)
+    form = tree.find('main').find('form').find('form')
+    await page.fill_text(form.find_id('textbox', 'Name'), name)
+    tree = await page.ax_tree()
+    await page.click(tree.find('main').find('form').find('form').find_id('button', 'Create'))
+    tree = await page.wait_for_ax('dialog', 'OAuth client created', timeout=timeout)
+    dialog = tree.find('dialog', 'OAuth client created')
+    values = [n.name.removeprefix('Copy to clipboard: ') for n in dialog.find_all('button', 'Copy to clipboard:')]
+    client_id = next((v for v in values if v.endswith('.apps.googleusercontent.com')), None)
+    client_secret = next((v for v in values if v != client_id), None)
+    if not client_id or not client_secret: raise RuntimeError('Google did not expose the new client credentials')
+    config = {'installed': {
+        'client_id': client_id, 'project_id': project_id, 'auth_uri': AUTH_URI,
+        'token_uri': TOKEN_URI, 'auth_provider_x509_cert_url': CERT_URI,
+        'client_secret': client_secret, 'redirect_uris': ['http://localhost']}}
+    _write_json(path, config)
+    await page.click(dialog.find_id('button', 'OK'))
+    return config
+
+
+async def authorize_gmail(
+    cdp:CDP, # CDP connection to a Chrome session signed into Google
+    client_path:str|Path='oauth-client.json', # Installed-app client JSON from create_gmail_client
+    token_path:str|Path='oauth-token.json', # Destination for access and refresh token JSON
+    scope:str=GMAIL_SCOPE, # OAuth scope to request
+    account:str=None, # Display-name or email substring when Google offers multiple accounts
+    timeout:int=600, # Seconds to wait for browser authorization
+) -> dict:
+    "Authorize Gmail in Chrome and save refreshable token JSON"
+    client = json.loads(Path(client_path).read_text())['installed']
+    callback = asyncio.get_running_loop().create_future()
+
+    async def receive_oauth(reader, writer):
+        request = (await reader.readline()).decode()
+        query = parse_qs(urlparse(request.split()[1]).query)
+        while await reader.readline() not in (b'\r\n', b''): pass
+        if not callback.done(): callback.set_result(query)
+        body = b'<h1>Authorization received</h1><p>You can close this tab.</p>'
+        headers = b'HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nContent-Length: ' + str(len(body)).encode() + b'\r\n\r\n'
+        writer.write(headers + body)
+        await writer.drain()
+        writer.close()
+
+    server = await asyncio.start_server(receive_oauth, '127.0.0.1', 0)
+    port = server.sockets[0].getsockname()[1]
+    verifier = secrets.token_urlsafe(64)
+    challenge = base64.urlsafe_b64encode(hashlib.sha256(verifier.encode()).digest()).rstrip(b'=').decode()
+    state = secrets.token_urlsafe(24)
+    redirect_uri = f'http://127.0.0.1:{port}/'
+    auth_url = 'https://accounts.google.com/o/oauth2/v2/auth?' + urlencode({
+        'client_id': client['client_id'], 'redirect_uri': redirect_uri, 'response_type': 'code',
+        'scope': scope, 'access_type': 'offline', 'prompt': 'consent',
+        'code_challenge': challenge, 'code_challenge_method': 'S256', 'state': state})
+    try:
+        auth_page = await cdp.new_page()
+        await cdp.target.activateTarget(targetId=auth_page.t)
+        await auth_page.goto(auth_url, timeout=60)
+        tree = await auth_page.ax_tree()
+        if tree.find('heading', 'Choose an account'):
+            accounts = [n for n in tree.find('list').find_all('link') if 'Use another account' not in n.name]
+            matches = accounts if account is None else [n for n in accounts if account.casefold() in n.name.casefold()]
+            if len(matches) != 1:
+                choices = ', '.join(n.name for n in accounts)
+                raise ValueError(f'Choose one Google account with account=: {choices}')
+            await auth_page.click(matches[0].find_id())
+        tree = await auth_page.wait_for_ax('button', 'Allow', timeout=timeout)
+        await auth_page.click(tree.find_id('button', 'Allow'))
+        query = await asyncio.wait_for(callback, timeout=timeout)
+    finally:
+        server.close()
+        await server.wait_closed()
+    if query.get('state') != [state]: raise RuntimeError('OAuth state did not match')
+    if 'error' in query: raise RuntimeError(query['error'][0])
+
+    async with httpx.AsyncClient() as http:
+        response = await http.post(TOKEN_URI, data={
+            'client_id': client['client_id'], 'client_secret': client['client_secret'],
+            'code': query['code'][0], 'code_verifier': verifier, 'redirect_uri': redirect_uri,
+            'grant_type': 'authorization_code'})
+    response.raise_for_status()
+    token = response.json()
+    token['client_id'] = client['client_id']
+    token['created_at'] = datetime.now(timezone.utc).isoformat()
+    _write_json(token_path, token)
+    return token

gclientid-0.1.0/gclientid/projects.py

@@ -0,0 +1,50 @@
+from urllib.parse import quote
+
+from fastcdp import Page
+
+
+CREATE_URL = 'https://console.cloud.google.com/projectcreate'
+SETTINGS_URL = 'https://console.cloud.google.com/iam-admin/settings'
+
+
+async def _replace_text(page:Page, node_id:int, text:str):
+    "Replace the contents of a text control"
+    await page.fill_text(node_id, text)
+
+
+async def create_project(page:Page, project_id:str, name:str=None, timeout:int=30) -> str:
+    "Create a Google Cloud project and return its project ID"
+    await page.goto(CREATE_URL, timeout=timeout)
+    tree = await page.wait_for_ax('textbox', 'Project name', timeout=timeout)
+    form = tree.find('main').find('form')
+    await _replace_text(page, form.find_id('textbox', 'Project name'), name or project_id)
+
+    tree = await page.wait_for_ax('button', 'Edit the project id.', timeout=timeout)
+    form = tree.find('main').find('form')
+    await page.click(form.find_id('button', 'Edit the project id.'))
+    tree = await page.wait_for_ax('textbox', 'Project ID', timeout=timeout)
+    form = tree.find('main').find('form')
+    await _replace_text(page, form.find_id('textbox', 'Project ID'), project_id)
+
+    tree = await page.wait_for_ax('button', 'Create', timeout=timeout)
+    await page.click(tree.find('main').find('form').find_id('button', 'Create'))
+    await page.wait_for_ax('button', f'Navigate to {project_id} project', timeout=timeout)
+    return project_id
+
+
+async def delete_project(page:Page, project_id:str, timeout:int=30) -> str:
+    "Shut down a Google Cloud project and return its project ID"
+    url = f'{SETTINGS_URL}?project={quote(project_id, safe="")}'
+    await page.goto(url, timeout=timeout)
+    tree = await page.wait_for_ax('button', 'Shut down', timeout=timeout)
+    await page.click(tree.find_id('button', 'Shut down'))
+
+    tree = await page.wait_for_ax('dialog', 'Shut down project', timeout=timeout)
+    dialog = tree.find('dialog', 'Shut down project')
+    await _replace_text(page, dialog.find_id('textbox', 'Project ID'), project_id)
+
+    tree = await page.ax_tree()
+    dialog = tree.find('dialog', 'Shut down project')
+    await page.click(dialog.find_id('button', 'Shut down anyway'))
+    await page.wait_for_ax('dialog', 'Project is pending deletion', timeout=timeout)
+    return project_id

gclientid-0.1.0/gclientid.egg-info/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: gclientid
+Version: 0.1.0
+Summary: Create Google OAuth desktop client IDs locally
+Author-email: Jeremy Howard <github@jhoward.fastmail.fm>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/AnswerDotAI/gclientid
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcdp>=0.0.8
+Requires-Dist: httpx
+Provides-Extra: dev
+Requires-Dist: fastship; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# gclientid
+
+Create Google OAuth desktop client IDs locally, without requiring `gcloud`.
+
+`gclientid` uses an existing signed-in [fastcdp](https://github.com/AnswerDotAI/fastcdp) Chrome session. Enable **Allow remote debugging** in `chrome://inspect/#remote-debugging`, then create a globally unique project ID, provision its Gmail Desktop OAuth client, and authorize the Gmail account:
+
+```python
+from gclientid import authorize_gmail, connect_browser, create_gmail_client, create_project
+
+cdp, page = await connect_browser()
+project_id = 'gclientids-your-unique-suffix'
+
+await create_project(page, project_id, name='gclientids')
+await create_gmail_client(page, project_id, 'oauth-client.json')
+await authorize_gmail(cdp, 'oauth-client.json', 'oauth-token.json')
+```
+
+`connect_browser()` uses the normal Chrome profile by default. Chrome gives you 60 seconds to approve the debugging connection. The function opens a new tab instead of navigating the currently focused tab. To use the separate CDP Chrome profile on port 9223 instead:
+
+```python
+cdp, page = await connect_browser(default_browser=False)
+```
+
+`create_gmail_client` enables the Gmail API, configures an External OAuth application, adds the full Gmail scope, publishes the unverified application, creates a Desktop client, and writes Google's installed-app client JSON. It selects an email offered by the signed-in Google account for the support and contact fields. It does not require an email or username argument.
+
+On a new Google Auth Platform application, `create_gmail_client` pauses at Google's API Services terms screen. Complete that visible screen in Chrome and the function continues. Pass `accept_terms=True` to accept and submit that screen automatically:
+
+```python
+await create_gmail_client(page, project_id, 'oauth-client.json', accept_terms=True)
+```
+
+`authorize_gmail` opens Google's account and consent screens in a new Chrome tab. It selects the account automatically when Google offers one existing account, then approves the requested Gmail access. When Google offers multiple existing accounts, select one by display name or email substring:
+
+```python
+await authorize_gmail(cdp, 'oauth-client.json', 'oauth-token.json', account='j@example.com')
+```
+
+The function uses a PKCE loopback flow and writes the access token, refresh token, granted scope, client ID, and creation time to `oauth-token.json`.
+
+Both JSON files are created with mode `0600`. `create_gmail_client` refuses to overwrite an existing client file because Google only exposes the Desktop client secret at creation time. `authorize_gmail` replaces the token file when authorization succeeds. Keep both files out of git.
+
+Project deletion is also available. Google keeps a deleted project recoverable for 30 days:
+
+```python
+from gclientid import delete_project
+
+await delete_project(page, project_id)
+```
+
+See the [privacy policy](PRIVACY.md) for how Google user data is handled.
+
+## Personal OAuth applications
+
+The intended setup is one Google Cloud project and Desktop OAuth client per
+developer. Configure its audience as **External**, publish it **In production**,
+and leave it unverified. Google may say that the app "requires verification",
+but personal-use applications can still authorize up to 100 distinct users.
+Users see an unverified-app warning during initial authorization; verification
+is only needed to remove that warning or exceed the lifetime user cap.
+
+Do not leave a continuously running application in **Testing**. Testing requires
+an explicit test-user email list, and authorizations requesting Gmail access
+expire after seven days. An unverified app that is In production needs neither
+the allowlist nor seven-day reauthorization.
+
+The unrestricted Gmail scope is `https://mail.google.com/`. It is a restricted
+scope and allows reading, composing, sending, and permanently deleting mail.
+The application must request this scope during authorization even when it is
+already listed on the Google Auth Platform Data Access page.
+
+Google currently requires a Desktop client's `client_secret` during the token
+exchange, including when PKCE is used. The secret is shown only when the client
+is created, so capture or download the client JSON immediately. Desktop software
+cannot keep this value confidential, but it must still be kept out of git along
+with user access and refresh tokens.
+
+## Development
+
+```bash
+pip install -e .[dev]
+```
+
+## Versioning
+
+Version lives in `gclientid/__init__.py` as `__version__`.
+Bump it with:
+
+```bash
+ship-bump --part 2   # patch
+ship-bump --part 1   # minor
+ship-bump --part 0   # major
+```
+
+## Release
+
+1) Ensure your GitHub issues are labeled (`bug`, `enhancement`, `breaking`).
+2) Run:
+
+```bash
+ship-release
+```

gclientid-0.1.0/gclientid.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+CHANGELOG.md
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+gclientid/__init__.py
+gclientid/oauth.py
+gclientid/projects.py
+gclientid.egg-info/PKG-INFO
+gclientid.egg-info/SOURCES.txt
+gclientid.egg-info/dependency_links.txt
+gclientid.egg-info/requires.txt
+gclientid.egg-info/top_level.txt

gclientid-0.1.0/gclientid.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gclientid-0.1.0/gclientid.egg-info/requires.txt

@@ -0,0 +1,7 @@
+fastcdp>=0.0.8
+httpx
+
+[dev]
+fastship
+build
+twine

gclientid-0.1.0/gclientid.egg-info/top_level.txt

@@ -0,0 +1 @@
+gclientid

gclientid-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gclientid"
+dynamic = ["version"]
+description = "Create Google OAuth desktop client IDs locally"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [{name = "Jeremy Howard", email = "github@jhoward.fastmail.fm"}]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+]
+
+dependencies = ["fastcdp>=0.0.8", "httpx"]
+
+[project.optional-dependencies]
+dev = [
+  "fastship",
+  "build",
+  "twine",
+]
+
+[project.urls]
+Homepage = "https://github.com/AnswerDotAI/gclientid"
+
+[tool.setuptools.dynamic]
+version = { attr = "gclientid.__version__" }
+
+[tool.setuptools.packages.find]
+include = ["gclientid"]

gclientid-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+