-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add import aliases to auth logic so our main readme uses them
- Loading branch information
1 parent
2fda909
commit cbaed38
Showing
19 changed files
with
487 additions
and
190 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
.openapi-generator/templates/python_doc_auth_partial.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| # Defining the host is optional and defaults to {{{basePath}}} | ||
| # See configuration.py for a list of all supported configuration parameters. | ||
| import {{{packageName}}} as {{{packageShorthand}}} | ||
|
|
||
| configuration = {{{packageShorthand}}}.Configuration( | ||
| host = "{{{basePath}}}" | ||
| ) | ||
|
|
||
| {{#hasAuthMethods}} | ||
| # The client must configure the authentication and authorization parameters | ||
| # in accordance with the API server security policy. | ||
| # Examples for each auth method are provided below, use the example that | ||
| # satisfies your auth use case. | ||
| {{#authMethods}} | ||
| {{#isBasic}} | ||
| {{#isBasicBasic}} | ||
|
|
||
| # Configure HTTP basic authorization: {{{name}}} | ||
| configuration = {{{packageShorthand}}}.Configuration( | ||
| username = os.environ["USERNAME"], | ||
| password = os.environ["PASSWORD"] | ||
| ) | ||
| {{/isBasicBasic}} | ||
| {{#isBasicBearer}} | ||
|
|
||
| # Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}} | ||
| configuration = {{{packageShorthand}}}.Configuration( | ||
| access_token = os.environ["BEARER_TOKEN"] | ||
| ) | ||
| {{/isBasicBearer}} | ||
| {{#isHttpSignature}} | ||
|
|
||
| # Configure HTTP message signature: {{{name}}} | ||
| # The HTTP Signature Header mechanism that can be used by a client to | ||
| # authenticate the sender of a message and ensure that particular headers | ||
| # have not been modified in transit. | ||
| # | ||
| # You can specify the signing key-id, private key path, signing scheme, | ||
| # signing algorithm, list of signed headers and signature max validity. | ||
| # The 'key_id' parameter is an opaque string that the API server can use | ||
| # to lookup the client and validate the signature. | ||
| # The 'private_key_path' parameter should be the path to a file that | ||
| # contains a DER or base-64 encoded private key. | ||
| # The 'private_key_passphrase' parameter is optional. Set the passphrase | ||
| # if the private key is encrypted. | ||
| # The 'signed_headers' parameter is used to specify the list of | ||
| # HTTP headers included when generating the signature for the message. | ||
| # You can specify HTTP headers that you want to protect with a cryptographic | ||
| # signature. Note that proxies may add, modify or remove HTTP headers | ||
| # for legitimate reasons, so you should only add headers that you know | ||
| # will not be modified. For example, if you want to protect the HTTP request | ||
| # body, you can specify the Digest header. In that case, the client calculates | ||
| # the digest of the HTTP request body and includes the digest in the message | ||
| # signature. | ||
| # The 'signature_max_validity' parameter is optional. It is configured as a | ||
| # duration to express when the signature ceases to be valid. The client calculates | ||
| # the expiration date every time it generates the cryptographic signature | ||
| # of an HTTP request. The API server may have its own security policy | ||
| # that controls the maximum validity of the signature. The client max validity | ||
| # must be lower than the server max validity. | ||
| # The time on the client and server must be synchronized, otherwise the | ||
| # server may reject the client signature. | ||
| # | ||
| # The client must use a combination of private key, signing scheme, | ||
| # signing algorithm and hash algorithm that matches the security policy of | ||
| # the API server. | ||
| # | ||
| # See {{{packageName}}}.signing for a list of all supported parameters. | ||
| from {{{packageName}}} import signing | ||
| import {{{packageName}}} as {{{packageShorthand}}} | ||
| import datetime | ||
|
|
||
| configuration = {{{packageShorthand}}}.Configuration( | ||
| host = "{{{basePath}}}", | ||
| signing_info = {{{packageShorthand}}}.HttpSigningConfiguration( | ||
| key_id = 'my-key-id', | ||
| private_key_path = 'private_key.pem', | ||
| private_key_passphrase = 'YOUR_PASSPHRASE', | ||
| signing_scheme = {{{packageShorthand}}}.signing.SCHEME_HS2019, | ||
| signing_algorithm = {{{packageShorthand}}}.signing.ALGORITHM_ECDSA_MODE_FIPS_186_3, | ||
| hash_algorithm = {{{packageShorthand}}}.signing.SCHEME_RSA_SHA256, | ||
| signed_headers = [ | ||
| {{{packageShorthand}}}.signing.HEADER_REQUEST_TARGET, | ||
| {{{packageShorthand}}}.signing.HEADER_CREATED, | ||
| {{{packageShorthand}}}.signing.HEADER_EXPIRES, | ||
| {{{packageShorthand}}}.signing.HEADER_HOST, | ||
| {{{packageShorthand}}}.signing.HEADER_DATE, | ||
| {{{packageShorthand}}}.signing.HEADER_DIGEST, | ||
| 'Content-Type', | ||
| 'Content-Length', | ||
| 'User-Agent' | ||
| ], | ||
| signature_max_validity = datetime.timedelta(minutes=5) | ||
| ) | ||
| ) | ||
| {{/isHttpSignature}} | ||
| {{/isBasic}} | ||
| {{#isApiKey}} | ||
|
|
||
| # Configure API key authorization: {{{name}}} | ||
| configuration.api_key['{{{name}}}'] = os.environ["API_KEY"] | ||
|
|
||
| # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed | ||
| # configuration.api_key_prefix['{{name}}'] = 'Bearer' | ||
| {{/isApiKey}} | ||
| {{#isOAuth}} | ||
|
|
||
| configuration.access_token = os.environ["ACCESS_TOKEN"] | ||
| {{/isOAuth}} | ||
| {{/authMethods}} | ||
| {{/hasAuthMethods}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.