Skip to content

Document key_file, cert_file, context params. #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2025
Merged

Document key_file, cert_file, context params. #672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions splunklib/binding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,12 @@ class Context:
:type verify: ``Boolean``
:param self_signed_certificate: Specifies if self signed certificate is used
:type self_signed_certificate: ``Boolean``
:param `key_file`: Path to a PEM-encoded private key.
:type key_file: ``string``
:param `cert_file`: Path to a PEM-encoded X509 certificate chain.
:type cert_file: ``string``
:param `context`: Custom SSLContext used with the HTTPSConnection, requires verify=True.
:type context: ``SSLContext``
:param sharing: The sharing mode for the namespace (the default is "user").
:type sharing: "global", "system", "app", or "user"
:param owner: The owner context of the namespace (optional, the default is "None").
Expand Down Expand Up @@ -1093,6 +1099,16 @@ def connect(**kwargs):
:type scheme: "https" or "http"
:param owner: The owner context of the namespace (the default is "None").
:type owner: ``string``
:param verify: Enable (True) or disable (False) SSL verification for https connections.
:type verify: ``Boolean``
:param self_signed_certificate: Specifies if self signed certificate is used
:type self_signed_certificate: ``Boolean``
:param `key_file`: Path to a PEM-encoded private key.
:type key_file: ``string``
:param `cert_file`: Path to a PEM-encoded X509 certificate chain.
:type cert_file: ``string``
:param `context`: Custom SSLContext used with the HTTPSConnection, requires verify=True.
:type context: ``SSLContext``
:param app: The app context of the namespace (the default is "None").
:type app: ``string``
:param sharing: The sharing mode for the namespace (the default is "user").
Expand Down Expand Up @@ -1505,16 +1521,16 @@ def handler(key_file=None, cert_file=None, timeout=None, verify=False, context=N
"""This class returns an instance of the default HTTP request handler using
the values you provide.

:param `key_file`: A path to a PEM (Privacy Enhanced Mail) formatted file containing your private key (optional).
:param `verify`: Enable (True) or disable (False) SSL verification for https connections.
:type verify: ``Boolean``
:param `key_file`: Path to a PEM-encoded private key.
:type key_file: ``string``
:param `cert_file`: A path to a PEM (Privacy Enhanced Mail) formatted file containing a certificate chain file (optional).
:param `cert_file`: Path to a PEM-encoded X509 certificate chain.
:type cert_file: ``string``
:param `context`: Custom SSLContext used with the HTTPSConnection, requires verify=True.
:type context: ``SSLContext``
:param `timeout`: The request time-out period, in seconds (optional).
:type timeout: ``integer`` or "None"
:param `verify`: Set to False to disable SSL verification on https connections.
:type verify: ``Boolean``
:param `context`: The SSLContext that can is used with the HTTPSConnection when verify=True is enabled and context is specified
:type context: ``SSLContext`
"""

def connect(scheme, host, port):
Expand Down
22 changes: 18 additions & 4 deletions splunklib/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,9 +314,16 @@ def connect(**kwargs):
:type port: ``integer``
:param scheme: The scheme for accessing the service (the default is "https").
:type scheme: "https" or "http"
:param verify: Enable (True) or disable (False) SSL verification for
https connections. (optional, the default is True)
:param verify: Enable (True) or disable (False) SSL verification for https connections.
:type verify: ``Boolean``
:param self_signed_certificate: Specifies if self signed certificate is used
:type self_signed_certificate: ``Boolean``
:param `key_file`: Path to a PEM-encoded private key.
:type key_file: ``string``
:param `cert_file`: Path to a PEM-encoded X509 certificate chain.
:type cert_file: ``string``
:param `context`: Custom SSLContext used with the HTTPSConnection, requires verify=True.
:type context: ``SSLContext``
:param `owner`: The owner context of the namespace (optional).
:type owner: ``string``
:param `app`: The app context of the namespace (optional).
Expand Down Expand Up @@ -391,9 +398,16 @@ class Service(_BaseService):
:type port: ``integer``
:param scheme: The scheme for accessing the service (the default is "https").
:type scheme: "https" or "http"
:param verify: Enable (True) or disable (False) SSL verification for
https connections. (optional, the default is True)
:param verify: Enable (True) or disable (False) SSL verification for https connections.
:type verify: ``Boolean``
:param self_signed_certificate: Specifies if self signed certificate is used
:type self_signed_certificate: ``Boolean``
:param `key_file`: Path to a PEM-encoded private key.
:type key_file: ``string``
:param `cert_file`: Path to a PEM-encoded X509 certificate chain.
:type cert_file: ``string``
:param `context`: Custom SSLContext used with the HTTPSConnection, requires verify=True.
:type context: ``SSLContext``
:param `owner`: The owner context of the namespace (optional; use "-" for wildcard).
:type owner: ``string``
:param `app`: The app context of the namespace (optional; use "-" for wildcard).
Expand Down