Groovy脚本自动集成Jenkins与Azure AD遇OicSecurityRealm类解析错误求助

解决Groovy脚本中OicSecurityRealm找不到的问题 #

你遇到的unable to resolve class OicSecurityRealm错误，核心原因是没有导入正确的类包，而且这个类属于Jenkins的「OpenID Connect Authentication」插件，必须先确保该插件已安装。下面是完整的修正方案：

1. 先确认插件已安装

OicSecurityRealm是Jenkins OpenID Connect插件提供的类，所以首先要保证这个插件已经在你的Jenkins实例上安装。如果需要自动化安装插件，可以在脚本开头添加这段代码：

def pluginManager = Jenkins.instance.pluginManager
def updateCenter = Jenkins.instance.updateCenter

// 检查OpenID Connect插件是否已安装
if (!pluginManager.getPlugin("openid")) {
    println "Installing OpenID Connect Authentication plugin..."
    def plugin = updateCenter.getPlugin("openid")
    if (plugin) {
        plugin.deploy()
        // 等待插件安装完成并重启Jenkins（可选，视情况而定）
        Jenkins.instance.restart()
    } else {
        println "OpenID Connect plugin not found in update center!"
        return
    }
}

2. 修正后的完整Groovy脚本

修正了导入包、参数类型错误（比如布尔值不要用字符串）、URL格式错误（https//改为https://）：

import jenkins.model.Jenkins
import hudson.plugins.openid.OicSecurityRealm

def instance = Jenkins.getInstance()

// Azure AD配置参数，请替换为你的实际值
String clientId = 'xxxx'
String clientSecret = 'xxxxxx'
String tokenServerUrl = 'https://login.microsoftonline.com/你的租户ID/oauth2/v2.0/token'
String authorizationServerUrl = 'https://login.microsoftonline.com/你的租户ID/oauth2/v2.0/authorize'
String userInfoServerUrl = 'https://graph.microsoft.com/oidc/userinfo'
String userNameField = 'sub'
String tokenFieldToCheckKey = ''
String tokenFieldToCheckValue = ''
String fullNameFieldName = 'name'
String emailFieldName = 'email'
String scopes = 'openid email profile'
String groupsFieldName = 'groups' // 如果需要同步Azure AD组，可设置为'groups'
boolean disableSslVerification = false
boolean logoutFromOpenidProvider = true
String endSessionUrl = 'https://login.microsoftonline.com/你的租户ID/oauth2/v2.0/logout'
String postLogoutRedirectUrl = 'https://你的Jenkins域名/logout'
boolean escapeHatchEnabled = false
String escapeHatchUsername = ''
String escapeHatchSecret = ''
String escapeHatchGroup = ''

// 初始化OicSecurityRealm实例
def adRealm = new OicSecurityRealm(
    clientId,
    clientSecret,
    tokenServerUrl,
    authorizationServerUrl,
    userInfoServerUrl,
    userNameField,
    tokenFieldToCheckKey,
    tokenFieldToCheckValue,
    fullNameFieldName,
    emailFieldName,
    scopes,
    groupsFieldName,
    disableSslVerification,
    logoutFromOpenidProvider,
    endSessionUrl,
    postLogoutRedirectUrl,
    escapeHatchEnabled,
    escapeHatchUsername,
    escapeHatchSecret,
    escapeHatchGroup
)

// 设置安全域并保存配置
instance.setSecurityRealm(adRealm)
instance.save()

println "Azure AD OpenID Connect集成配置已成功应用！"

3. 脚本使用说明

• 可以直接在Jenkins的「脚本控制台」（路径：Manage Jenkins > Script Console）中运行这段脚本。
• 如果需要远程执行，可以使用Jenkins CLI工具：

  java -jar jenkins-cli.jar -s https://你的Jenkins域名/ groovy = < azure-ad-integration.groovy
  

备选方案：使用curl调用Jenkins API实现自动化 #

如果Groovy脚本执行有障碍，也可以通过Jenkins的配置API来完成，步骤如下：

1. 获取Jenkins的Crumb（防止CSRF）：

   CRUMB=$(curl -s 'https://你的Jenkins域名/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,":",//crumb)')
   

2. POST配置到Jenkins API：
   把下面的XML中的占位符替换为你的实际配置，然后发送请求（注意添加管理员凭证-u 用户名:密码）：

   curl -X POST -u 管理员用户名:密码 -H "$CRUMB" -H "Content-Type: application/xml" -d '
   <jenkins>
     <securityRealm class="hudson.plugins.openid.OicSecurityRealm">
       <clientId>xxxx</clientId>
       <clientSecret>xxxxxx</clientSecret>
       <tokenServerUrl>https://login.microsoftonline.com/你的租户ID/oauth2/v2.0/token</tokenServerUrl>
       <authorizationServerUrl>https://login.microsoftonline.com/你的租户ID/oauth2/v2.0/authorize</authorizationServerUrl>
       <userInfoServerUrl>https://graph.microsoft.com/oidc/userinfo</userInfoServerUrl>
       <userNameField>sub</userNameField>
       <fullNameFieldName>name</fullNameFieldName>
       <emailFieldName>email</emailFieldName>
       <scopes>openid email profile</scopes>
       <groupsFieldName>groups</groupsFieldName>
       <disableSslVerification>false</disableSslVerification>
       <logoutFromOpenidProvider>true</logoutFromOpenidProvider>
       <endSessionUrl>https://login.microsoftonline.com/你的租户ID/oauth2/v2.0/logout</endSessionUrl>
       <postLogoutRedirectUrl>https://你的Jenkins域名/logout</postLogoutRedirectUrl>
       <escapeHatchEnabled>false</escapeHatchEnabled>
     </securityRealm>
   </jenkins>
   ' https://你的Jenkins域名/config.xml
   

内容的提问来源于stack exchange，提问作者MMA