Skip to content

Conversation

@Ghufz
Copy link
Contributor

@Ghufz Ghufz commented Jun 12, 2023

Currently, the HttpSigningConfiguration object only accepts the API key in PEM/txt file format. However, if we need to retrieve the API key from a vault or another tool in string format, it is not possible to use it directly without saving it to a file.

To address this limitation, a pull request (PR) has been made to introduce a new property called KeyString. This property allows the user to provide the API key as a string. As a result, users now have the flexibility to either provide the API key file path using the existing parameter "KeyFilePath" or provide it as a string using the newly exposed property "KeyString".

Here is the example of API key as string.

var httpSignConfig = new HttpSigningConfiguration()
{
	KeyId = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	KeyString = "-----BEGIN RSA PRIVATE KEY-----\r\nxxxxxxxxxxxxxx\r\n-----END RSA PRIVATE KEY-----\r\n",
       HttpSigningHeader = new System.Collections.Generic.List<string> { "(request-target)", "Host", "Date", "Digest" }
}

Here is the sample code for API key file path

var httpSignConfig = new HttpSigningConfiguration()
{
	KeyId = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	KeyFilePath = "c:\users\xyz\apikey.txt",
       HttpSigningHeader = new System.Collections.Generic.List<string> { "(request-target)", "Host", "Date", "Digest" }
}

PR checklist

  • Read the contribution guidelines.

  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.

  • Run the following to build the project and update samples:

    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    

    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.

  • In case you are adding a new generator, run the following additional script :

    ./bin/utils/ensure-up-to-date
    

    Commit all changed files.

  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)

  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328

code-lucidal58 and others added 28 commits November 2, 2020 23:13
pulling in the python set-item fix from master
pull in golang restrict read-only props changes from upstream
@wing328
Copy link
Member

wing328 commented Jun 13, 2023

FYI @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@wing328 wing328 added this to the 7.0.0 milestone Jun 13, 2023
@wing328 wing328 merged commit 9fe5cc0 into OpenAPITools:master Jun 13, 2023
fmoraespadtec pushed a commit to padteclab/openapi-generator that referenced this pull request Jun 26, 2023
…ngConfiguration (OpenAPITools#15818)

* added property in HttpSIgningConfiguration to accept API key in string format.

* remove trailing space, update samples

* updated the sample code.

* Revert "updated the sample code."

This reverts commit 5b945c7.

* fix the sample code compilation error for split function.

* updated the sample code after the split function fix.

* Removed the either or check for filePath or KeyString.

---------

Co-authored-by: Aanisha Mishra <[email protected]>
Co-authored-by: Vikrant Balyan (vvb) <[email protected]>
Co-authored-by: Vikrant Balyan <[email protected]>
Co-authored-by: Sebastien Rosset <[email protected]>
Co-authored-by: William Cheng <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants