Jenkins Checkmarx Plugin / Scan 安裝元件及送掃

Hachibye
6 min readSep 13, 2021

--

環境:Macbook Air M1
Plugin:以Checkmarx為例

Step.1 在Jenkins網頁端,管理Jenkins > 管理外掛程式

Step.2 選擇「可用的」分頁,輸入搜尋關鍵字,並勾選安裝

Step.3 稍等片刻,安裝中的畫面(可以手動重啟服務)

Step.4 手動重啟服務

brew services restart jenkins

Step.5 查看外掛程式裡面是否已經安裝完畢

Step.6 進行初步設置
在Dashboard > 管理Jenkins > 設定系統(全域設定及路徑)

Step.7 將自己原本的localhost改為實際ip位置
加上http或https,還有port號(預設就是8080)

Step.8 設定Checkmarx所在的主機地址,點選「Add」添加登入的帳號密碼(不一定要是管理者),以及註解(方便辨識)

Step.9 設定專案的預設值
(1)弱點的閥值
(2)timeout的時間

Step.10
儲存設定

以上就是安裝外掛程式和預先設定了

接下來是如何開始一個任務,以及加入掃描

Step.1 新增作業

Step.2 輸入作業名稱(與Checkmarx無關)

Step.3 輸入描述(方便辨識)

Step.4 輸入Git的Repository URL,登入驗證,以及Branches位置

Step.5 在建置步驟裡選取「Execute Checkmarx Scan」

Step.6 輸入或選擇專案名稱,小組,規則集合

Step.7 選擇是否為差異掃描(如果是第一次送掃就不要勾!)

Step.8

Step.9 選擇產出PDF報告,並儲存設定

設定好任務之後,就是開心的送掃了

如果送掃失敗要注意一下錯誤訊息,通常可解

Step.1 點入專案(任務),並點選「馬上建置」來開始

Step.2 觀察左下角的「建置歷程」查看是否成功或失敗

Step.3 查看檢測大綱,或者下載結果報告

除錯筆記:

(1)Couldn’t find any revision to build. Verify the repository and branch configuration for this job.
→ Github的Branch分支沒寫對

(2)Failed to generate access token, failure error was: Status code: 400, message:
→ 帳號密碼輸入錯誤,以至於連不上伺服器

(3)java.lang.NullPointerException / java.lang.NullPointerException
→ 這個真的很奇葩,也猜不出問題來源,最後發現到明明是第一次送掃,卻勾選了差異掃描,以至於報錯,取消打勾就行了

(4)No engine can reserve memory for this scan
→ 大多情況是你的Checkmarx資源不足,請釋放資源之後重試

以上就大功告成

實際操作了一遍之後發現不是那麼麻煩

第一次理所當然會痛苦一點(?)

--

--

Hachibye

字幕組退休勞工 ... DevOps/系統/雲端/資安