{"id":22280974,"url":"https://github.com/jenkinsci/mask-passwords-plugin","last_synced_at":"2025-04-07T12:11:00.775Z","repository":{"id":858913,"uuid":"1163640","full_name":"jenkinsci/mask-passwords-plugin","owner":"jenkinsci","description":"Mask Passwords plugin for Jenkins","archived":false,"fork":false,"pushed_at":"2025-03-01T02:28:19.000Z","size":329,"stargazers_count":22,"open_issues_count":0,"forks_count":50,"subscribers_count":101,"default_branch":"master","last_synced_at":"2025-03-31T11:04:56.634Z","etag":null,"topics":["security"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/mask-passwords","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenkinsci.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2010-12-13T05:44:03.000Z","updated_at":"2025-03-01T02:28:22.000Z","dependencies_parsed_at":"2023-10-01T22:32:59.161Z","dependency_job_id":"751d89a0-3805-464e-afc7-d82362958055","html_url":"https://github.com/jenkinsci/mask-passwords-plugin","commit_stats":{"total_commits":166,"total_committers":23,"mean_commits":7.217391304347826,"dds":0.6927710843373494,"last_synced_commit":"3804f82a1a83946446f0810528de3e9e296c926c"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fmask-passwords-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fmask-passwords-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fmask-passwords-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fmask-passwords-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/mask-passwords-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648977,"owners_count":20972945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["security"],"created_at":"2024-12-03T16:11:16.182Z","updated_at":"2025-04-07T12:11:00.732Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mask Passwords plugin for Jenkins\n\nThis plugin allows masking passwords that may appear in the console.\n\n## About this plugin\n\nThis plugin allows masking passwords that may appear in the console,\nincluding the ones defined as build parameters.\nThis often happens, for example, when you use build steps which *can't* handle passwords properly.\nTake a look at the following example.\n\n### Before\n\nConsider you're using an **Invoke Ant** build step to run an Ant target.\nThis target requires a password to achieve its goal.\nYou would end up having a job configuration like this:\n\n![](docs/images/config-before.png)\n\nOf course, you could have created a variable to store the password and use this variable in the build step configuration so that it doesn't appear as plain text.\nBut you would still end with a console output like this:\n\n![](docs/images/console-before.png)\n\n### After\n\nWhen activating the **Mask passwords** option in a job, the builds' **Password Parameters**\n(or any other type of build parameters selected for masking in **Manage Jenkins** \\\u003e **Configure System**) are automatically masked from the console.\nFurthermore, you can also safely define a list of static passwords to be masked\n(you can also define a list of static password shared by all jobs in Jenkins' main configuration screen).\nAs such, the passwords don't appear anymore as plain text in the job configuration\n(plus it is ciphered in the job configuration file):\n\n![](docs/images/config-after.png)\n\nOnce done, new builds will have the passwords masked from the console output:\n\n![](docs/images/console-after.png)\n\n## User guide\n\nFirst, go to Jenkins' main configuration screen (**Manage Jenkins** \\\u003e **Configure System**) and select,\nin the **Mask Passwords - Configuration** section, which kind of build parameters have to be automatically masked from the console output:\n\n![](docs/images/global-settings.png)\n\nNotice that, as of version 2.7, you can also define global passwords (defined as pairs of name/password) that can be accessed across all jobs.\n\nThen, for a specific job, activate the **Mask passwords** option in the **Build Environment** section to mask passwords from the console:\n\n1.  All the password parameters defined for the job will be automatically hidden.\n2.  For each other kind of password (that is, static ones) that may appear in the console output,\n    add an entry (by clicking on the **Add** button) and set the **Password** field.  \n    You may additionally set the **Name** field.\n    If you do so, the password will then be available as a standard variable.\n    It is then possible to refer to this password using this variable rather than keying it in a field which is not ciphered.\n    Take a look at the screenshots above for an example.\n\n## Release Notes\n\n* See [GitHub Releases](https://github.com/jenkinsci/mask-passwords-plugin/releases) for recent releases\n* See the [Changelog archive](./docs/CHANGELOG.old.md) for 2.12.0 and before\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fmask-passwords-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fmask-passwords-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fmask-passwords-plugin/lists"}