{
    "componentChunkName": "component---src-templates-plugin-docs-tsx",
    "path": "/plugins/scm-signature-check-plugin/docs/latest/en/usage/",
    "result": {"data":{"plugin":{"name":"scm-signature-check-plugin","displayName":"Signature Check Plugin","description":"Plugin to check if all changesets of a push have a valid signature","author":"Cloudogu GmbH","documentation":[{"version":"3.1.x","languages":["de","en"]},{"version":"3.0.x","languages":["de","en"]},{"version":"1.0.x","languages":["en","de"]}]},"navigation":{"nodes":[{"section":"Getting started","entries":[{"frontmatter":{"title":"Usage","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-signature-check-plugin/docs/3.1.x/en/usage/"}}]}]},"versions":{"group":[{"fieldValue":"1.0.x"},{"fieldValue":"3.0.x"},{"fieldValue":"3.1.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"<p>By default, changesets can be pushed to a repository without a signature.\nWith the Signature Check plugin, this can be prevented so that only signed changesets can be pushed.</p>\n<p>The specific behavior of the signature check can be set at global, namespace and repository level.\nInitially, only the global setting is active.\nHowever, the namespace settings can explicitly override the global setting.\nIn this case, the namespace setting is active instead of the global setting.\nSimilarly, the repository setting can overwrite the global and namespace setting.\nWhen overwriting, the settings are not merged, instead only the now active setting is applied.</p>\n<p>To prevent overwriting, you can explicitly disable all repository settings in the namespace setting.\nThis will disable the settings for all repositories that belong to that namespace.\nThis applies even if the repository setting overrides the namespace setting.\nSimilarly, you can explicitly disable all namespace and repository settings in the global setting.\nThis would make only the global setting active.</p>\n<h2 id=\"global-settings\" style=\"position:relative;\"><a href=\"#global-settings\" aria-label=\"global settings permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Global Settings</h2>\n<p>In order to open the global setting, one should open the <code class=\"language-text\">Administration</code> page via the primary navigation.\nAnd then navigate via the secondary navigation to <code class=\"language-text\">Settings</code> and the subitem <code class=\"language-text\">Signature Check</code>.\nIf the corresponding options are not available in the navigation, then the required <a href=\"#Permissions\">permissions</a> are missing.</p>\n<p>In the global setting, one can first specify via checkbox whether the namespace and repository settings should be explicitly disabled.\nNext, you can use a checkbox to enable the feature to check every changeset for a valid signature.\nAs soon as the check is activated, further options become visible to the user.</p>\n<p>This allows the user to specify via chip input which branches should be protected from unsigned changesets during a push.\nIf the chip input is empty, then all branches are protected.\nOtherwise, only the specified branches are protected.</p>\n<p>Next, the user can specify via radio buttons which gpg signatures are allowed.\nEither any signatures can be allowed or it must be the signature of an SCM manager user.\nIf any signatures are allowed and the used public key of a signature is known to the SCM manager,\nthen the signature must also match the content of the respective changeset, otherwise the push with this changeset will be rejected.\nIf the public key is not known, it is not possible to check whether the signature is correct.\nIn this case it is sufficient if the changeset has a signature.\nIf only signatures of SCM Manager users are allowed, then a check is made for each signature,\nwhether the public key belongs to a user and whether the signature matches the changeset.\nOtherwise, the push would be rejected with the respective changeset.</p>\n<p>Finally, the user has to save his settings with the <code class=\"language-text\">Save</code> button.</p>\n<h2 id=\"namespace-settings\" style=\"position:relative;\"><a href=\"#namespace-settings\" aria-label=\"namespace settings permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Namespace Settings</h2>\n<p>To open the namespace setting you first have to go to the <code class=\"language-text\">Repositories</code> page via the primary navigation.\nHere you can see an overview of all namespaces and the repositories they contain.\nNext to each namespace there is a button to open the page with the settings for that namespace.\nOn this page you can open the <code class=\"language-text\">Signature Check</code> settings via the secondary navigation.\nIf the corresponding options are not available in the navigation, then the required <a href=\"#Permissions\">permissions</a> are missing or the namespace setting has been disabled globally.</p>\n<p>In the namespace setting, you can use a checkbox to first specify whether the global setting should be overwritten.\nThis would only affect the respective namespace.\nAs soon as the global setting is set to be overwritten, further setting options are shown to the user.\nThe next setting allows the user to specify via checkbox whether the repository settings should be explicitly disabled.\nThis would only affect the repositories that are located in the respective namespace.\nThe subsequent setting options are analogical to the global setting.</p>\n<h2 id=\"repository-settings\" style=\"position:relative;\"><a href=\"#repository-settings\" aria-label=\"repository settings permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Repository Settings</h2>\n<p>To open the repository setting you first have to go to the <code class=\"language-text\">Repositories</code> page via the primary navigation.\nHere you can see an overview of all namespaces and the repositories they contain.\nThen you have to click on the repository you want to configure, this will open the page of the repository.\nWith the secondary navigation and the subitem <code class=\"language-text\">Signature Check</code> in the tab <code class=\"language-text\">Settings</code> the repository setting can be opened.\nIf the corresponding options are not present in the navigation, then the required <a href=\"#Permissions\">permissions</a> are missing or the repository setting has been disabled globally or by namespace.</p>\n<p>First, the user can use a checkbox to specify whether the settings from this repository should override the global and respective namespace setting.\nIn case of an override, further setting options are displayed analogical to the global setting.</p>\n<h2 id=\"permissions\" style=\"position:relative;\"><a href=\"#permissions\" aria-label=\"permissions permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Permissions</h2>\n<p>To read or change the settings it needs the respective permissions.\nFor the global setting at least the <code class=\"language-text\">Administer permissions</code> and the <code class=\"language-text\">Modifiy signature check configuration</code> permissions are required.\nFor the namespace setting, the <code class=\"language-text\">Read permissions on namespaces</code> permission must exist globally and the <code class=\"language-text\">configurate signature check</code> permission must exist for the respective namespace.\nFor the repository setting, the same permissions as for the namespace setting must be assigned at namespace or repository level.</p>","description":"By default, changesets can be pushed to a repository without a signature.\nWith the Signature Check plugin, this can be prevented so that only signed changesets…","tableOfContents":"<ul>\n<li><a href=\"#global-settings\">Global Settings</a></li>\n<li><a href=\"#namespace-settings\">Namespace Settings</a></li>\n<li><a href=\"#repository-settings\">Repository Settings</a></li>\n<li><a href=\"#permissions\">Permissions</a></li>\n</ul>","frontmatter":{"title":"Usage","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-signature-check-plugin","slug":"/plugins/scm-signature-check-plugin/docs/3.1.x/en/usage/","version":"3.1.x","latestVersion":"3.1.x","latestPageVersion":"3.1.x","language":"en","canonicalPath":"/plugins/scm-signature-check-plugin/docs/latest/en/usage/","latestRootPath":"/plugins/scm-signature-check-plugin/docs/3.1.x/en/"}},
    "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}