美文网首页.NET相关技术
基于角色策略访问Jenkins API

基于角色策略访问Jenkins API

作者: Grom_Li | 来源:发表于2019-04-11 14:16 被阅读16次

简介

  Jenkins是一个开源软件项目,是基于Java开发的一种持续集成工具,用于监控持续重复的工作,旨在提供一个开放易用的软件平台,使软件的持续集成变成可能。

入口

  首先在Jenkins主页选择系统管理, 选择全局安全配置

Management

在Authorization(授权)中选择Role-Based Strategy(基于角色策略)

Authorization

  项目矩阵授权策略也比较常见,配置也很简单,在角色管理中配置相应的角色和组后可以在这里对角色和组进行授权即可。


  在安装了第三方Jenkins插件 Role Strategy Plugin 后,即可在管理页面看到 Manage and Assign Roles,进入后如下图。


  

角色配置

  选择Manage Roles,进行角色配置
  这里是为了授权已登录或有合法Token的用于可以正确的调用Job API,所以添加角色User,授权至少要有Read和Build,其他权限可根据实际情况配置。
  更改授权策略会清空除了操作账号外所有已绑定的用户!

用户配置

  选择Assign Roles,对用户进行角色的指派


  通过User/group to add添加用户,然后分配角色配置中配置好的角色。
  笔者这里是使用GitHub账户登录过来的,所以要先登录GitHub账号,这里User/group显示的账号,然后加载时被动态修改成了昵称,可以在刷新的一瞬间看到,昵称的设置可以在右上角进入自己的Config进行设置,Anonymous为未登录的匿名用户,这里只允许登录的用户进行访问,图中有两个相同昵称的账号,其实是不同的账号相同的昵称,下面会说明原因。
  另外有权限登录的这个界面的用户可以互删!!哪怕都是Admin!!!(就是说你可以删掉你的Leader的权限)
  

Token配置

  在首页选择People

  这里可以看到Jenkins中的所有用户,但请注意,这里的个人用户名全部被Jenkins定为了小写!笔者的GitHub账号是大写,这里记录的是小写,Jenkins大部分情况是不区分大小写的,除了调用API的账号!也就是说,即使按照按照下文的配置完成后调用API也会报 “xinzheng-li is missing the Overall/Read permission” 的异常,因为笔者的账号是大写首字母!
  为了解决这个问题,只好在Assign Roles里面加入小写账号,Jenkins因为已经录入了大写的账号,所以会识别出来并显示昵称,所以出现了有两个相同的账号昵称。把GitHub账号也就是登录Jenkins的账号修改为小写理论上也可行,笔者这里不再测试。
右边的On是角色的范围,这里使用全局账号进行配置,点击账号名称,点击Configure。



Token注意保存,关闭页面后将无法再次看到,如遗忘可重新生成。

API地址

  为了方便理解,下文中所有的Jenkins根目录使用{JenkinsURL}代替,Job的名称使用{JobName}代替。
  首先,可以在https://{JenkinsURL}/api/json中看到Jenkins的整体配置和Job的api接口地址,一般为https://{JenkinsURL}/job/{JobName}。
  调用具体Job API的文档可以在https://{JenkinsURL}/job/{JobName}/api下面看到


调用Jenkins API

  调用API无非就是像Jenkins服务器发起请求,在C#中的HttpWebRequest,WebClient,HttpClient或者其他类库,Js中的Ajax,CMD中的curl等等均可实现。Authorization由用户名加冒号加Token组成,如: xinzheng-li:1234567890。URL无参数可使用{JobName}/build,部分URL区分大小写

CMD命令:

      curl https://{JenkinsURL}/job/{JobName}/buildWithParameters?{Parameters} -X POST --user xinzheng-li:1234567890

Powershell脚本(需要对Authorization 进行 Basic64编码并在前面加“Basic ”):

      $Url = "https://$JenkinsURL/job/$JobName/buildWithParameters"
      $byteArray = [System.Text.UnicodeEncoding]::UTF8.GetBytes("xinzheng-li:1234567890")
      $Auth =  [Convert]::ToBase64String($byteArray)
      $Paras = "A=1&B=2"
      $Response =Invoke-WebRequest $Url -Headers @{"Authorization"= "Basic $Auth"} -Method POST -Body $Paras -UseBasicParsing

C# (同样需要Basic编码)

      byte[] byteArray = Encoding.UTF8.GetBytes("A=1&B=2");
      HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
      request.Headers.Add(HttpRequestHeader.Authorization, "Basic abcdefghigklmnopqrstuvwxyz");
      request.Method = "POST";
      request.PreAuthenticate = true;
      request.ContentLength = byteArray.Length;
      Stream newStream = request.GetRequestStream();
      newStream.Write(byteArray, 0, byteArray.Length);
      newStream.Close();

      HttpWebResponse response = (HttpWebResponse)request.GetResponse();
      using (StreamReader read = new StreamReader(response.GetResponseStream(), Encoding.GetEncoding("utf-8")))
      {
            string content = read.ReadToEnd();
      }
      var result = response.Headers["Location"];

  在返回的Headers中可以得到Location:https://{JenkinsURL}/queue/item/{Queueid}/
笔者推测Jenkins想直接返回Job的Url,但不知道怎么留了这个BUG,访问此url会得到404,不过我们可以通过分割URL得到Queueid,这个是全局的TaskId,目前也没有直接可以通过Queueid得到TaskId的方法,只能调用API获取最后一次的TaskId和Queueid,通过比较Queueid来确定TaskId是否是刚刚触发的TaskId。

查询最后一次构建的TaskId和QueueId

      $url = "$JenkinsURL/job/$JobName/lastBuild/api/json?pretty=true&tree=queueId,number"

  如果QueueId不符,则可以通过增减TaskId替换调lastBuild再次查询比较,直到得到准确的TaskId。
  最后,在通过计时器等方式循环访问API获取结果,如果构建较快,也可以在查询TaskId的时候直接在url后增加result参数获取结果。

      $url = "$JenkinsURL/job/$JobName/$TaskId/api/json?pretty=true&tree=number,result"

欢迎来我的博客查看更多文章

相关文章

网友评论

    本文标题:基于角色策略访问Jenkins API

    本文链接:https://www.haomeiwen.com/subject/dkozbqtx.html