search

WattTime / watttime-python-client

A software development kit for the WattTime API, showing basic examples of usage.
7 stars 6 forks source link

Add Custom SSL Certificate Verification in wattime/api.py #24

Open malakhalifa0 opened 2 months ago

malakhalifa0 commented 2 months ago

Currently, Watttime does not support specifying a custom SSL certificate for verification when making requests. It defaults to using the system's SSL certificate store, which might not be suitable for all environments or security requirements.

To improve security and compatibility with specific use cases, watttime/api.py should be updated to allow users to specify a custom certificate path for SSL verification. This would ensure that API calls can trust a specific certificate rather than relying solely on the system's certificate store.

PR Reference: I've submitted a Pull Request that implements this feature (#23). Please review the changes and let me know if there are any adjustments needed.

malakhalifa0 commented 2 months ago

@Henry-WattTime @sam-watttime @xginn8

Hello,

I hope you're doing well! I wanted to follow up on the Pull Request I submitted last week regarding adding support for custom SSL certificate verification; I've opened a new issue above and my team and I would really appreciate your feedback. Please let me know if there are any changes you'd like to see, or if there's anything preventing the PR from getting merged.

Thanks!

xginn8 commented 1 month ago

Hi @malakhalifa0 and thanks for this contribution! Since we're just using the requests library under the hood, can you set the REQUESTS_CA_BUNDLE env var to automatically load that cert (as outlined in their docs here: https://docs.python-requests.org/en/latest/user/advanced/#ssl-cert-verification)? I'm curious if that'll work for you in your use case, or if we still need to potentially handle cert verification in our SDK.

Please let us know if you're able to test that and what the results are!!

malakhalifa0 commented 1 month ago

Thanks @xginn8 for the tip! It does work locally, but we believe it's good practice to have the verify parameter as an argument in the request, so that a certificate - if needed - could be passed explicitly. If we're using other python libraries, that under the hood are using REQUESTS_CA_BUNDLE, setting this env variable can change the performance of these or disrupt their behaviour. Having the verify parameter in Watttime's SDK would also significantly help with the debugging.