DevOps / Jenkins

Jenkins隐藏任务中的密码

温馨提示:本文最后更新于2021-08-15 20:24:18,某些文章具有时效性,若有错误或已失效,请在下方留言或提交工单提交工单
浅时光 · 8月2日 · 2021年 本文1095个字,预计阅读3分钟 4450次已读

一、场景描述


我们在通过Jenkins去构建、或者部署某些服务、再或者去SSH远程到某台节点主机上执行一些脚本等等,在这些场景下,我们肯定会使用到密码,那么Jenkins默认情况下不进行任何处理的话,在前端展示UI和控制台日志输出中都会将我们传入的密码以明文的方式展示出来,这个时候就大大降低了服务访问的安全性,所以我们就需要通过下面的方法将UI和控制台日志输出中的密码进行隐藏。

二、UI界面隐藏


对Jenkins构建Job任务的UI界面上隐藏一些关键性的参数,例如:密码,在Jenkins的参数化构建中默认有个密码参数,这个参数可以对UI中输入的内容进行隐藏,设置如下:

Jenkins隐藏任务中的密码-浅时光博客
Jenkins隐藏任务中的密码-浅时光博客
Jenkins隐藏任务中的密码-浅时光博客

三、控制台隐藏


  • 上面的方式只可以隐藏Job UI上的一些参数,但是无法隐藏控制台日志中输出的一些关键信息,这个时候我们就需要使用到插件Mask Passwords
  • 插件介绍:https://plugins.jenkins.io/mask-passwords/

1、启用Mask Password

Jenkins隐藏任务中的密码-浅时光博客
Jenkins隐藏任务中的密码-浅时光博客

2、Job任务中选择密码参数

Jenkins隐藏任务中的密码-浅时光博客

3、Pipeline中实现方法

#!groovy
@Library('jenkinslib') _     
def tool = new org.devops.tool()
pipeline {
    agent  { 
        any 
    }
    stages {
        stage('Checkout') {
            steps {
                script {
                    tool.PrintMes("========Check Out========",'green')
                }
            }
        }

        stage('TEST Passwd') {
            steps{
                script {
                    tool.PrintMes("========TEST Passwd========",'green')
                }
                //控制台日志中将打印Passwd参数的值替换为****;注意Passwd是与上面参数化构建中我们选择密码参数时定义的Name名称保持一致
                wrap([$class: 'MaskPasswordsBuildWrapper', varPasswordPairs: [[var: 'Passwd', password: Passwd]], varMaskRegexes: []]) {
                    sh '''
                        echo ${Passwd}
                    '''
                }
            }
        }
    }

    post {
		success {
		    script {
                         tool.PrintMes("========流水线执行成功========",'green')

		    }
		}
		failure {
		    script {
		        tool.PrintMes("========流水线执行失败========",'red')

		    }
		}
	}
}
  • 执行任务查看效果,如下图所示,控制台输出的日志中展示的密码被隐藏了,这就达到了我们所要的效果了。
Jenkins隐藏任务中的密码-浅时光博客



本文作者:浅时光
原文链接:https://www.dqzboy.com/7423.html
版权声明:知识共享署名-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)协议进行许可
转载时请以超链接形式标明文章原始出处和作者信息

1 条回应

必须 注册 为本站用户, 登录 后才可以发表评论!

  1. 好運黏黏上海2021-8-2 · 16:15

    好久没过来了,过来学习下,支持博主

本站已稳定运行: | 耗时 0.392 秒 | 查询 20 次 | 内存 35.54 MB