Skip to content

Latest commit

 

History

History
148 lines (110 loc) · 4.83 KB

README.md

File metadata and controls

148 lines (110 loc) · 4.83 KB
Raw

Drive CSE Upload

With Google Workspace Client-side encryption (CSE), you can add another layer of encryption to your organization's data — like files and emails — in addition to the default encryption that Google Workspace provides.

For select Google Workspace editions, admins can import sensitive files from third-party storage using Client-side encryption and the Google Drive API, preserving the confidentiality of your data. Eligible admins can apply for beta access using this form.

In this package we are providing a code sample (in the form of a Python library) to upload files hosted locally to Google Drive as Client-side encrypted (CSE) files.

Project Prerequisites

Google Cloud

  • Have a Cloud project

  • Have Google Drive API enabled for the project

  • Have a user with an admin rights in that project

  • Have a service-account configured for the project

  • Have the service-account provisioned for Domain Wide Delegation

  • Store the Service Account Private Key File downloaded during the account creation

    Note: The file is only downloaded during creation; you cannot re-download it

Identity Provider (IDP)

  • Have an OAuth Client ID for Desktop
  • Download and store the Client Secret File for the configured OAuth Client Id

Google Admin Console

  • Have CSE configured for the domain
  • Have an IDP configured for the domain
  • Have a KACLS configured for the domain

Key ACL Service (KACLS)

  • The KACLS must support the /privilegedwrap, /privilegedunwrap, and /digest endpoints
  • Have the KACLS configured for the domain allow /privilegedwrap and /privilegedunwrap by the admin user
  • Have the KACLS configured for the domain allow /digest by Google
  • See https://developers.google.com/workspace/cse/reference

Installing this Package

The easiest way to install this package is to get it from PyPi:

pip install drive-cse-upload

This will get this package and all of its dependencies.

Details

If you get this package from GitHub, you'll need to install its dependencies separately.

Python
  • Python 3.10.7 or greater
Tink Cryptographic Library
pip3 install tink>=1.10.0
Google Client Library
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

Running the Example

  • Set these parameters to match your setup

    • SA_KEY_FILE: The Service Account Private Key File
    • CLIENT_SECRET_FILE: The OAuth Client Secret File
    • SAVED_CREDS_FILE: Where to store the IDP Oauth credentials
    • AS_USER: Upload the file as this user (an email-address)
    • INPUT_FILE The file to upload
    • PARENT_ID The parent folder/shared-drive for the uploaded file (optional)

    Note: The first three files listed above contain sensitive information that should be protected. Users must ensure that the files passed-in / created are not readable by anyone but their owner.

$ python example.py \
  --sa-key-file "${SA_KEY_FILE}" \
  --client-secret-file "${CLIENT_SECRET_FILE}" \
  --saved-creds-file "${SAVED_CREDS_FILE}" \
  --as-user "${AS_USER}" \
  "${INPUT_FILE}"

This will upload and validate the file ${INPUT_FILE} to ${AS_USER}'s root MyDrive.

$ python example.py \
  --sa-key-file "${SA_KEY_FILE}" \
  --client-secret-file "${CLIENT_SECRET_FILE}" \
  --saved-creds-file "${SAVED_CREDS_FILE}" \
  --as-user "${AS_USER}" \
  --parent-id "${PARENT_ID}" \
  "${INPUT_FILE}"

This will upload and validate the file ${INPUT_FILE} as a child of the folder or shared-drive designated by ${PARENT_ID}.

As part of the upload process, you'll be prompted to open a browser window with a URL for authenticating with the IDP. Enter the admin user credentials there to continue.

When done, the code will print the name and the id of the newly uploaded file. You can see the file in the Drive web client. To ensure that the file is uploaded correctly, now try the "Download and decrypt" action. This should download the decrypted file to your local host.