Jenkins声明式流水线如何避免控制台打印带认证信息的curl命令
解决Jenkins控制台明文回显带认证信息curl命令的实现方案
你遇到的日志明文问题由两个因素叠加导致:
- 手动计算的base64认证串不属于Jenkins凭据插件托管的原生敏感变量,插件的自动打码逻辑完全识别不到该值的敏感性
- Jenkins执行
sh步骤传入的单行字符串脚本时,默认会给临时生成的shell脚本前置开启set -x调试模式,把所有执行的命令带+前缀回显到控制台,连带把敏感认证串一起打印出来
核心调整步骤(完全适配现有双引号单行sh写法,无需切换到三单引号代码块)
- 在原有
sh步骤传入的脚本字符串最开头,加上set +x;命令- 这个命令会直接覆盖Jenkins默认注入的
set -x调试逻辑,从根源上关掉shell的命令回显,不会再出现带+前缀的curl命令打印 - 直接在原来的单行脚本字符串前面拼接即可,和原有写法完全兼容
- 这个命令会直接覆盖Jenkins默认注入的
- 给
sh步骤补充label参数- 补充参数后,Jenkins控制台只会打印你设置的可读步骤名称,不会把具体执行的命令作为步骤说明打印出来
- 注册手动生成的base64认证串为日志遮蔽对象
- 因为你是自己拼接字符串计算的base64认证值,不是
withCredentials直接注入的环境变量,Jenkins默认不会对这个值做打码处理,哪怕关了命令回显,一旦后续curl报错、接口返回里不小心带上这个值,还是会明文泄露 - 用Jenkins内置的
maskStrings步骤把这个动态生成的认证串注册进去后,后续所有控制台日志里只要出现这个字符串,都会自动替换为***
- 因为你是自己拼接字符串计算的base64认证值,不是
改造后的完整代码示例
stage('xxx'){ steps{ script{ withCredentials([usernamePassword( credentialsId: 'Openshift_Credentials', passwordVariable: 'OPENSHIFT_PASSWORD', usernameVariable: 'OPENSHIFT_USERNAME' )]) { def encodedAuth = "${OPENSHIFT_USERNAME}:${OPENSHIFT_PASSWORD}".bytes.encodeBase64().toString() // 注册敏感值到日志遮蔽规则,所有出现该值的日志会自动打码 maskStrings([encodedAuth]) // 完全保留原有双引号单行curl的写法,仅在最前面追加set +x,补充label参数 def data = sh( returnStdout: true, script: "set +x; curl -k --form version=${XXX} --form env=${XXX} --form app=${XXX} -H \"Authorization: Basic ${encodedAuth}\" \"SOME_API\"", label: "调用业务接口获取版本部署信息" ).trim() print data } } } }
实际运行效果
- 控制台原来带
+ curl ...的命令回显会完全消失,只会显示[Pipeline] sh (调用业务接口获取版本部署信息)的步骤提示 - curl本身的进度输出(即下载/上传速率的统计表格)还是会正常显示,不会受
set +x影响 - 所有日志流里只要出现那个base64编码的认证串,都会被自动替换为
***,哪怕不小心被其他输出带出来也不会泄露
注意事项
- 一定要把
set +x;放在脚本字符串的最开头,否则如果放在其他命令后面,前面的命令还是会被xtrace回显 maskStrings步骤依赖Jenkins的Mask Passwords插件,常规Jenkins实例默认都会预装这个插件- 这种写法完全不需要用三单引号的
sh '''...'''代码块,所有字符串都是双引号包裹的Groovy变量拼接,和现有代码结构100%兼容
内容的提问来源于stack exchange,提问作者Harshit Goel
相关产品推荐
相关产品推荐

