Skip to content

Add openssl smime troubleshooting for x509 commits

Ben Prescott_ requested to merge docs/bprescott/20240219-x509smime into master

What does this MR do?

Add some more troubleshooting for x509 / SMIME signing of commits

We assume that the only reason for pkcs7_verify failing is that the root is missing.

unsupported certificate purpose - for one - is not caused by a missing root. And Rails doesn't surface this error.

Dropping down to the command line means folks get a more generic way to test signature verification that's more likely to have good clues from internet searches.

We still refer to some old bugs as limitations. I've added notes about the applicability of these issues.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Ben Prescott_

Merge request reports