WebSVN – php-qbpwcf – /trunk/usr/bin/getCert.php

#!/usr/bin/php
<?php

/*
        QBPWCF, Quick Build PHP website Component base on Fedora Linux.
    Copyright (C) 2014~2026 MIN ZHI, CHEN

    This file is part of QBPWCF.

    QBPWCF is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    QBPWCF is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with QBPWCF.  If not, see <http://www.gnu.org/licenses/>.

*/

/*

程式說明:
取得Zerossl上的憑證資訊

*/

#使用命名空間qbpwcf
namespace qbpwcf;

#取得 lib path
exec("php -f ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/libexec/folderOfUsrLib.php"),$output,$status);

#如果執行失敗
if($status!==0){

        #debug
        var_dump(__LINE__,$output);

        #結束執行,回傳shell 1.
        exit(1);

        }#if end

#儲存lib path
$folderOfUsrLib=$output[0];

#以該檔案的實際位置的 lib path 為 include path 首位
$output=array();
exec("cd ".escapeshellarg(pathinfo(__FILE__)["dirname"]."/../".$folderOfUsrLib."/qbpwcf").";pwd;",$output,$status);

#如果執行失敗
if($status!==0){

        #debug
        var_dump(__LINE__,$output);

        #結束執行,回傳shell 1.
        exit(1);

        }#if end

#設置 include path
set_include_path($output[0].PATH_SEPARATOR.get_include_path());

#匯入外部套件
require_once("allInOne.php");

#該指令的 help 文件
function help(){

        #印出指令說明
        echo basename($_SERVER["PHP_SELF"])." is a program to encrypt string or stdin by gpg then stdout.".PHP_EOL;
        echo basename($_SERVER["PHP_SELF"])." usage:".PHP_EOL;
        echo "--apiDomain [zerossl api domain, default is api.zerossl.com]".PHP_EOL;
        echo "--apiKey [zerossl api key, default is from etc/qbpwcf/allInOneConig.php]".PHP_EOL;
        echo "--search [keyword to search].".PHP_EOL;
        echo "--cerStatus [certificate status], value can be \"pending_validation\"代表zerossl尚在產生憑證;\"issued\"代表已經可以下載來使用;\"revoked\"代表已經廢除;\"cancelled\"代表已經取消且未驗證;\"expired\"代表已經過期. 若要多種狀態則可以用逗號(\",\")區隔. ".PHP_EOL;
        echo "--cerType [certificate type/valid days], value can be \"single90Days\"代表單一domain90天效期的;\"wildcard90Days\"代表所有子網域90效期的;\"multiDomain90Days\"多個domain90天效期的;\"single1Year\"單一domain一年效期的;\"wildcard1Year\"所有子網域一年效期的;\"multiDomain1Year\"多個網域一年效期的;\"acme90Days\"透過acme取得的90天效期.".PHP_EOL;
        echo "--limit [max data count per page], default value is 100.".PHP_EOL;
        echo "--page [page number], default value is 1.".PHP_EOL;
        
        #結束執行
        exit;

        }#function help end
        
#函式說明:
#解析參數.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$reuslt["error"],執行不正常結束的錯訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["content"],解析好的參數陣列.
#$result["content"][$key][$i],參數 $key 的 $i+1 個參數數值內容.
#$result["program"],字串,執行的程式名稱.
#必填參數:
#無
#可省略參數:
#$conf["helpFunc"],如果解析的參數不成對，則要執行的函式名稱.
$conf["helpFunc"]="help";
#備註:
#僅能在命令列底下執行.
#建議:
#以後可將參數 --a--b 的名稱與後面的數值 $value 存成 $result["a"]["b"][$i]=$value .
$parseArgu=cmd::parseArgu($conf);
unset($conf);

#如果解析參數失敗
if($parseArgu["status"]==="false"){

        #印出結果
        var_dump($parseArgu);

        #結束執行,回傳 shell 1
        exit(1);

        }#if end

#函式說明:
#檢查必填與可省略的參數，可省略參數可指定預設要給與什麼數值內容.
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$result["error"],執行不正常結束的錯訊息陣列.
#$result["simpleError"],簡單表示的錯誤訊息.
#$result["function"],當前執行的函式名稱.
#$result["argu"],設置給予的參數.
#$result["passed"],識別要檢查的全體變數是否存在以及型態是否正確的變數,"true"代表檢查全部通過;"false"代表檢查不通過
#$result[$shouldBeCheckedVarName]["varExist"],所檢查的變數是否存在,"false"代表不存在;"true"代表存在
#$result[$shouldBeCheckedVarName]["varType"],所檢查的變數型態是否正確,"false"代表錯誤;"true"代表正確
#$result[$shouldBeCheckedVarName]["error"],每個參數設定的錯誤訊息
#$result["shouldNotBeEmpty"],不應該為空字串或控陣列的變數.
#$result["argu"],字串陣列,目前輸入的參數名稱陣列.
#$result["legalVarName"],字串陣列,合法可用的參數名稱陣列.
#$result["notNeedVar"],字串陣列,多餘的參數名稱.
#必填參數:
#$conf["varInput"],陣列變數,要檢查的陣列變數,請在要檢查的參數前面加上&，這樣變動的結果才能被套用。
$conf["varInput"]=&$parseArgu["content"];
#$conf["referenceVarKey"],字串,$conf參數後面的key值,用於移除不要的參考陣列.
$conf["referenceVarKey"]="variableCheck::checkArguments";
#可省略參數:
#$conf["mustBeFilledVariableName"],爲必填參數的變數名稱陣列，形態爲陣列變數，元素數量需要跟"mustBeFilledVariableType"參數的元素數量一致,例如: $conf["mustBeFilledVariableName"] = array("id","account","password");
#$conf["mustBeFilledVariableName"]=array();
#$conf["mustBeFilledVariableType"],爲必填參數的變數陣列應該爲何種變數形態，形態爲陣列,元素數量需要跟"mustBeFilledVariableName"參數的元素數量一致,例如: $conf["mustBeFilledVariableType"] = array("string",integer,"double","resource","object"); , null、any代表不指定變數形態.其中 resource也包含"resource (closed)".
#$conf["mustBeFilledVariableType"]=array();
#$conf["canBeEmptyString"],字串,必填變數內容如果是空字串就不能算是有設置的話，請設為"false",預設爲"true",可以為空字串.
#$conf["canBeEmptyString"]="false";
#$conf["canNotBeEmpty"],字串陣列,哪些必填參數的內容不得為空字串或空陣列,僅當$conf["canBeEmptyString"]為"true"時會生效.
#$conf["canNotBeEmpty"]=array();
#$conf["canBeEmpty"],字串陣列,哪些必填參數的內容可為空字串或空陣列,僅當$conf["canBeEmptyString"]為"false"時會生效.
#$conf["canBeEmpty"]=array();
#$conf["skipableVariableCanNotBeEmpty"],字串陣列,哪些可省略參數不可以為空字串或空陣列.
#$conf["skipableVariableCanNotBeEmpty"]=array();
#$conf["skipableVariableName"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableName"] = array("id","account","password");
$conf["skipableVariableName"]=array("apiDomain","apiKey","search","cerStatus","cerType","limit","page");
#$conf["skipableVariableType"],陣列字串,爲可省略參數的變數名稱陣列，形態爲陣列變數，例如: $conf["skipableVariableType"] = array("string",integer,"double");
$conf["skipableVariableType"]=array("array","array","array","array","array","array","array");
#$conf["skipableVarDefaultValue"],字串陣列,每個不存在的可省略變數要初始化為什麼,null與代表不指定,若預設值是參數之一，請將$conf["mustBeFilledVar"]改成"\$conf["\mustBeFilledVar\"]".
$conf["skipableVarDefaultValue"]=array(null,null,null,null,null,null,null);
#$conf["disallowAllSkipableVarIsEmpty"],字串,是否允許每個可省略參數都為空字串,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmpty"]="";
#$conf["disallowAllSkipableVarIsEmptyArray"],字串,是否允許每個可省略參數都為空陣列,預設為"true"允許,反之為"false".
#$conf["disallowAllSkipableVarIsEmptyArray"]="";
#$conf["disallowAllSkipableVarNotExist"],字串,是否不允許每個可省略參數都不存在,預設為"false"代表允許,反之為"true".
#$conf["disallowAllSkipableVarNotExist"]="";
#$conf["arrayCountEqualCheck"],字串陣列,為檢查哪些陣列參數的元素數量要一樣,$conf["arrayCountEqualCheck"][$i]=array()為第$i組key為哪些的變數其元素數量要相等.
#$conf["arrayCountEqualCheck"][]=array();
#參考資料:
#array_keys=>http://php.net/manual/en/function.array-keys.php
#備註:
#無.
$checkArguments=variableCheck::checkArguments($conf);
unset($conf);

#如果執行異常
if($checkArguments["status"]==="false"){

        #debug
        var_dump($checkArguments);

        #結束執行,回傳 shell 1
        exit(1);

        }#if end
        
#如果執行異常
if($checkArguments["passed"]==="false"){

        #debug
        var_dump($checkArguments);

        #結束執行,回傳 shell 1
        exit(1);

        }#if end

#初始化設定
$conf=array();
        
#如果有參數 apiDomain
if(isset($parseArgu["content"]["apiDomain"])){

        #設置 apiDomain 參數
        $conf["apiDomain"]=$parseArgu["content"]["apiDomain"][0];

        }#if end
        
#如果有參數 apiKey
if(isset($parseArgu["content"]["apiKey"])){

        #設置 key 參數
        $conf["key"]=$parseArgu["content"]["apiKey"][0];

        }#if end
        
#如果有參數 search
if(isset($parseArgu["content"]["search"])){

        #設置 search 參數
        $conf["search"]=$parseArgu["content"]["search"][0];

        }#if end
        
#如果有參數 cerStatus
if(isset($parseArgu["content"]["cerStatus"])){

        #設置 cerStatus 參數
        $conf["cerStatus"]=$parseArgu["content"]["cerStatus"][0];

        }#if end
        
#如果有參數 cerType
if(isset($parseArgu["content"]["cerType"])){

        #設置 cerType 參數
        $conf["cerType"]=$parseArgu["content"]["cerType"][0];

        }#if end
        
#如果有參數 limit
if(isset($parseArgu["content"]["limit"])){

        #設置 limit 參數
        $conf["limit"]=$parseArgu["content"]["limit"][0];

        }#if end
        
#如果有參數 page
if(isset($parseArgu["content"]["page"])){

        #設置 page 參數
        $conf["page"]=$parseArgu["content"]["page"][0];

        }#if end
        
#函式說明:
#取得在zerossl上的CSR清單
#回傳結果:
#$result["status"],執行是否正常,"true"代表正常,"false"代表不正常.
#$reuslt["error"],執行不正常結束的錯訊息陣列.
#$result["function"],當前執行的函式名稱.
#$result["argu"],所使用的參數.
#$result["curl_verbose_info"],curl執行的詳細資訊.
#$result["content"],結果json字串.
#$result["tCount"],總共的資料筆數.
#$result["count"],該頁的筆數.
#$result["page"],當前的頁碼.
#$result["certs"],陣列,certificates清單,key為certificate的id.
#$result["certs"][$cerId]["cname"],該certificate主要包含的 domain name.
#$result["certs"][$cerId]["anames"],該certificate額外包含的 domain name.
#$result["certs"][$cerId]["expiresYMD"],該certificate最後有效年月日,格式為"2020-07-28 00:00:00".
#$result["certs"][$cerId]["expiresIn"],該certificate距離系統時間還有多少秒數就過期.
#$result["certs"][$cerId]["status"],該certificate憑證的狀態,可能的數值有:"draft"代表尚未驗證;"pending_validation"代表zerossl尚在產生憑證;"issued"代表已經可以下載來使用;"revoked"代表已經廢除;"cancelled"代表已經取消且未驗證;"expired"代表已經過期.
#必填參數:
#無
#可省略參數:
#$conf["apiDomain"],字串,提供服務的domain,預設為 self::getApiInfo()["doamin"].
#$conf["apiDomain"]=self::getApiInfo()["doamin"];
#$conf["key"],字串,api key,預設為 self::getApiInfo()["apiKey"].
#$conf["key"]=self::getApiInfo()["apiKey"];
#$conf["cerStatus"],字串,需要取得的certificate狀態,預設為全部,若要多個狀態,可用","區隔,可以用的狀態有"draft"代表尚未驗證;"pending_validation"代表zerossl尚在產生憑證;"issued"代表已經可以下載來使用;"revoked"代表已經廢除;"cancelled"代表已經取消且未驗證;"expired"代表已經過期.
#$conf["cerStatus"]="";
#$conf["cerType"],字串,需要取得的certificate類型,預設為不篩選,可以用的類型有"single90Days"代表單一domain90天效期的;"wildcard90Days"代表所有子網域90效期的;"multiDomain90Days"多個domain90天效期的;"single1Year"單一domain一年效期的;"wildcard1Year"所有子網域一年效期的;"multiDomain1Year"多個網域一年效期的;"acme90Days"透過acme取得的90天效期.
#$conf["cerType"]="";
#$conf["search"],字串,透過certificate包含的domain來搜尋.
#$conf["search"]="";
#$conf["limit"],字串,一頁要多少筆,預設為100筆.
#$conf["limit"]="";
#$conf["page"],字串,要第幾頁的資料,預設為第一頁.
#$conf["page"]="";
#參考資料:
#https://zerossl.com/documentation/api/list-certificates/
#備註:
#無.
$getCertList=zerossl::getCertList($conf);
unset($conf);

#debug
var_dump($getCertList);
Subversion Repositories php-qbpwcf

(root)/trunk/usr/bin/getCert.php – Rev 309
