Skip to content
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.

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

Add End Entity/Certificate Profile fields to CertSafePublisher's JSON #742

Open
wants to merge 6,613 commits into
base: main
Choose a base branch
from

Conversation

mwllgr
Copy link

@mwllgr mwllgr commented Dec 12, 2024

Describe your changes

This pull request introduces five additional fields in CertSafePublisher's JSON POST data:

  • username
  • certificateProfileId
  • certificateProfileName
  • endEntityProfileId
  • endEntityProfileName

Due to the JSON structure changes, a documentation update at https://doc.primekey.com/ejbca/ejbca-operations/ejbca-ca-concept-guide/publishers-overview/custom-publishers/cert-safe-publisher-for-an-https-server would be necessary.

One might even think about making these changes additional for existing EJBCA installations by using a dedicated checkbox (as a "feature flag", probably?) as some systems might not handle the newly introduced fields correctly.

How has this been tested?

We're currently using the CertSafePublisher with these changes in several systems running EJBCA. The implementation publishes certificate data to a custom API which consumes the JSON content and then publishes certificate details into a dedicated Jira project.

I currently do not have any possibility to execute EJBCA's unit tests, so extending the existing CertSafePublisherUnitTest might be necessary.

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have kept the patch limited to only change the parts related to the patch
  • This change requires a documentation update

samuellbKF and others added 30 commits April 2, 2024 14:09
…est' into 'main'

ECA-12287: fix adjust timeout in test

Closes ECA-12287

See merge request ejbca/ejbca!1519
no-ticket: update swagger to match api definitions

See merge request ejbca/ejbca!1525
…-empty-name' into 'main'

ECA-11972 - Block clone/creation of certificate profile when the name is empty or contains

Closes ECA-11972

See merge request ejbca/ejbca!1517
…' into 'main'

ECA-12338 - Add user-friendly error message for rename approval profile action

Closes ECA-12338

See merge request ejbca/ejbca!1515
'fb-ECA-12237-Remove_ca.keystorepass_and_ca.cmskeystorepass' of
https://neo.repoman.primekey.com/ejbca/ejbca into
fb-ECA-12237-Remove_ca.keystorepass_and_ca.cmskeystorepass
…oken in RaMasterApiProxyBean and RaMasterApiPeerImpl
Comment out .image.tag so the correct version number from Chart.yaml
is used and update src/internal.properties to make Jenkins X compute
the correct build number.
ECA-12104: p11ng-cli command to list usable key pairs

Closes ECA-12104

See merge request ejbca/ejbca!1378
CI pipeline step name typo fix

See merge request ejbca/ejbca!1528
fix: Admin GUI French fixes

See merge request ejbca/ejbca!1532
primetomas and others added 25 commits August 19, 2024 02:17
Correct FindEndEntityCommand help text
…hangs

Post-upgrade hangs when `crldata_idx3` or `crldata_idx4` exist
Fix: RA GUI layout (CSS align, SDA bug, Search improv)
Update EJBCA Installation link in README to docs.keyfactor.com
Links still to be added.
…ersystems/8.3.2

L10n: French GUI fix (Peer Systems)
Added OpenSSF Best Practices badge in README
@primetomas
Copy link
Collaborator

Would this normally be backwards compatible? I.e should a normal end point simply ignore the new fields?

@mwllgr
Copy link
Author

mwllgr commented Dec 13, 2024

Thanks for the quick response @primetomas! I assume software that receives the JSON would usually not care if there are more fields than initially known. As I did not remove any fields I think this shouldn't really be a problem.

@hesunmark hesunmark force-pushed the main branch 2 times, most recently from 647a632 to e3961c2 Compare December 19, 2024 11:02
@primetomas
Copy link
Collaborator

I'm sorry, but we just pushed EJBCA 9.0 to GitHub, which means the PR is messed up and have to be redone/rebased.
Apart from that, I like it very much and I should be able to merge it next year.
Can you rebase the PR for the updated ejbca-ce git?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.