Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions parameter-sets/credential/parameter-set.json
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,15 @@
{
"name": "mtls_certificate_path",
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it should no longer be named path

Suggested change
"name": "mtls_certificate_path",
"name": "mtls_certificate",

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about that one:

  • we still accept path in this variable
  • it will create incompatibilities with presets created during the beta testing phase, which is fine because that was a beta testing phase, but will still create some confusion...

"label": "Path to certificate",
"description": "",
"type": "STRING",
"description": "or full certificate starting with -----BEGIN and ending with END CERTIFICATE-----",
"type": "PASSWORD",
"visibilityCondition": "model.use_mtls==true"
},
{
"name": "mtls_key_path",
"label": "Path to key",
"description": "",
"type": "STRING",
"description": "or full key starting with -----BEGIN and ending with END PRIVATE KEY-----",
"type": "PASSWORD",
"visibilityCondition": "model.use_mtls==true"
}
]
Expand Down
8 changes: 4 additions & 4 deletions parameter-sets/secure-basic/parameter-set.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@
{
"name": "mtls_certificate_path",
"label": "Path to certificate",
"description": "",
"type": "STRING",
"description": "or full certificate starting with -----BEGIN and ending with END CERTIFICATE-----",
"type": "PASSWORD",
"visibilityCondition": "model.use_mtls==true"
},
{
"name": "mtls_key_path",
"label": "Path to key",
"description": "",
"type": "STRING",
"description": "or full key starting with -----BEGIN and ending with END PRIVATE KEY-----",
"type": "PASSWORD",
"visibilityCondition": "model.use_mtls==true"
}
]
Expand Down
8 changes: 4 additions & 4 deletions parameter-sets/secure-oauth/parameter-set.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@
{
"name": "mtls_certificate_path",
"label": "Path to certificate",
"description": "",
"type": "STRING",
"description": "or full certificate starting with -----BEGIN and ending with END CERTIFICATE-----",
"type": "PASSWORD",
"visibilityCondition": "model.use_mtls==true"
},
{
"name": "mtls_key_path",
"label": "Path to key",
"description": "",
"type": "STRING",
"description": "or full key starting with -----BEGIN and ending with END PRIVATE KEY-----",
"type": "PASSWORD",
"visibilityCondition": "model.use_mtls==true"
}
]
Expand Down
4 changes: 2 additions & 2 deletions python-lib/dku_constants.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
class DKUConstants(object):
API_RESPONSE_KEY = "api_response"
FORBIDDEN_KEYS = ["token", "password", "api_key_value", "secure_token"]
FORBIDDEN_KEYS = ["token", "password", "api_key_value", "secure_token", "mtls_key_path", "mtls_certificate_path"]
FORM_DATA_BODY_FORMAT = "FORM_DATA"
PLUGIN_VERSION = "1.2.7"
PLUGIN_VERSION = "1.2.7-beta.5"
RAW_BODY_FORMAT = "RAW"
REPONSE_ERROR_KEY = "dku_error"
43 changes: 41 additions & 2 deletions python-lib/rest_api_client.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import requests
import time
import copy
import tempfile
from pagination import Pagination
from safe_logger import SafeLogger
from loop_detector import LoopDetector
Expand Down Expand Up @@ -184,14 +185,35 @@ def request(self, method, url, can_raise_exeption=True, **kwargs):
def request_with_redirect_retry(self, method, url, **kwargs):
# In case of redirection to another domain, the authorization header is not kept
# If redirect_auth_header is true, another attempt is made with initial headers to the redirected url
response = self.session.request(method, url, **kwargs)
response = self.request_with_cert(method, url, **kwargs)
if self.redirect_auth_header and not response.url.startswith(url):
redirection_kwargs = copy.deepcopy(kwargs)
redirection_kwargs.pop("params", None) # params are contained in the redirected url
logger.warning("Redirection ! Accessing endpoint {} with initial authorization headers".format(response.url))
response = self.session.request(method, response.url, **redirection_kwargs)
response = self.request_with_cert(method, response.url, **redirection_kwargs)
return response

def request_with_cert(self, method, url, **kwargs):
cert = kwargs.get("cert", None)
if cert and len(cert) == 2:
if cert[0].startswith("-----BEGIN CERTIFICATE") and cert[1].startswith("-----BEGIN "):
logger.info("mTLS certificate and key are strings")
response = None
with tempfile.NamedTemporaryFile(mode="w", suffix=".crt") as tmp_certificate:
with tempfile.NamedTemporaryFile(mode="w", suffix=".key") as tmp_key:
tmp_certificate.write(
normalize_key(cert[0])
)
tmp_certificate.seek(0)
tmp_key.write(
normalize_key(cert[1])
)
tmp_key.seek(0)
kwargs["cert"] = (tmp_certificate.name, tmp_key.name)
response = self.session.request(method, url, **kwargs)
return response
return self.session.request(method, url, **kwargs)

def paginated_api_call(self, can_raise_exeption=True):
if self.pagination.params_must_be_blanked:
self.requests_kwargs["params"] = {}
Expand Down Expand Up @@ -278,3 +300,20 @@ def get_headers(response):
if isinstance(response, requests.Response):
return response.headers
return None


def normalize_key(key):
PROTECTED_EXPRESSIONS = [
"BEGIN CERTIFICATE", "END CERTIFICATE",
"BEGIN PRIVATE KEY", "END PRIVATE KEY",
"BEGIN RSA PRIVATE KEY", "END RSA PRIVATE KEY"
]
tempo_text = str(key)
for expression_to_protect in PROTECTED_EXPRESSIONS:
protected_form = expression_to_protect.replace(" ", "")
tempo_text = tempo_text.replace(expression_to_protect, protected_form)
tempo_text = tempo_text.replace(" ", "\n")
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be avoided if the input to the cert was a textarea instead of a input field? If I understand correctly we're trying to rebuild the certificate content because it was flattened when the user pasted into the input field

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to use the password type here so that the certificate and key are encrypted on the instance... Using Textarea would be less safe in that regard.

for expression_to_protect in PROTECTED_EXPRESSIONS:
protected_form = expression_to_protect.replace(" ", "")
tempo_text = tempo_text.replace(protected_form, expression_to_protect)
return tempo_text