Revise proxy configuration, add integration testing

pinecone-io / pinecone-python-client

The Pinecone Python client

Apache License 2.0

284 stars 78 forks source link

Problem

We want to expose proxy configuration fields as top-level config params and move away from users passing an OpenApiConfiguration instance with openapi_config (as was done in 2.x versions of the sdk). Passing these objects is not something we documented or had shown as a named configuration param, but is something people assumed would work as a hangover from the way things were done in the old client.

Currently OpenApi generated code is part of our implementation, but we may want to swap out something else in the future so it doesn't make sense to use this OpenApiConfiguration object as part of our public interface. And since the openapi config object also needs to be configured with api key and host, it competes with these other config params in a way that is pretty confusing.

Solution

Add new configuration parameters for proxy_url, proxy_headers, ssl_ca_certs, and ssl_verify.
Document the use of these properties in the README and doc strings
Emit a warning message when users are passing openapi_config encouraging them to use the new properties.
Implement integration tests that run with mitmproxy docker image. For now these are only run in local development.

Usage

from pinecone import Pinecone
import urllib3 import make_headers

pc = Pinecone(
    api_key="YOUR_API_KEY",
    proxy_url='https://your-proxy.com',
    proxy_headers=make_headers(proxy_basic_auth='username:password'),
    ssl_ca_certs='path/to/cert-bundle.pem'
)

This will work, but should emit a deprecation warning:

from pinecone import Pinecone
from pinecone.core.client.configuration import OpenApiConfiguration
import urllib3 import make_headers

config = OpenApiConfiguration()
config.ssl_ca_certs = 'path/to/cert-bundle.pem'
config.proxy_headers = make_headers(proxy_basic_auth='username:password')
config.proxy_url = 'https://your-proxy.com'

pc = Pinecone(
    api_key="YOUR_API_KEY",
    openapi_config=config
) # emits deprecation notice

Future work

We will need to figure out how to deploy the mitmproxy elsewhere (cloud run?) before running tests in CI because Github Actions seems to have a lot of issues with running these docker containers and debugging the errors has proven quite difficult. While GHA can run docker containers, mounting a volume with the required certs causes the container to crash. I'm guessing this is some kind of file permissions issue, but don't have much visibility for debugging.

Type of Change

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update
[ ] Infrastructure change (CI configs, etc)
[ ] Non-code change (docs, etc)
[ ] None of the above: (explain here)

Test Plan

Run new tests locally with PINECONE_API_KEY='foo' PINECONE_INDEX_NAME='bar' poetry run pytest tests/integration/proxy_config/ -s -v

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [10042887](https://dashboard.gitguardian.com/incidents/10042887?occurrence=127292450) | Triggered | RSA Private Key | b9517f27d2363861a59c421a086705abc9a2e130 | tests/integration/proxy_config/.mitm/proxy1/mitmproxy-ca.pem | [View secret](https://github.com/pinecone-io/pinecone-python-client/commit/b9517f27d2363861a59c421a086705abc9a2e130#diff-24d23c709aac8c15bd797b60ad620b8b0a76485671652b7721d8624b82a47a5cR1) | | [10042888](https://dashboard.gitguardian.com/incidents/10042888?occurrence=127292459) | Triggered | RSA Private Key | b9517f27d2363861a59c421a086705abc9a2e130 | tests/integration/proxy_config/.mitm/proxy2/mitmproxy-ca.pem | [View secret](https://github.com/pinecone-io/pinecone-python-client/commit/b9517f27d2363861a59c421a086705abc9a2e130#diff-97bf7390f207d598cc2181fd9d054c66f54b9b9a5982697bcc644d802373cc80R1) |

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/specifics/private_key_rsa#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

pinecone-io / pinecone-python-client