Caddy 原始碼閱讀（一）Run 詳解

前言

本次系列會講解 caddy 整個生命週期涉及到的原始碼。

平時我們使用 caddy 都是使用 它的 二進位制 分發檔案，現在來分析 caddy 的 Run 函式。
從最外層邏輯看它都做了些什麼。

Caddy Run

我們來看看 Caddy Run 中引入了哪些包和操作，對 Caddy 的總體行為做一個概覽
caddy/caddymain/run.go
首先看 init 函式

func init() {
    caddy.TrapSignals()

    flag.BoolVar(&certmagic.Default.Agreed, "agree", false, "Agree to the CA's Subscriber Agreement")
    flag.StringVar(&certmagic.Default.CA, "ca", certmagic.Default.CA, "URL to certificate authority's ACME server directory")
    flag.StringVar(&certmagic.Default.DefaultServerName, "default-sni", certmagic.Default.DefaultServerName, "If a ClientHello ServerName is empty, use this ServerName to choose a TLS certificate")
    flag.BoolVar(&certmagic.Default.DisableHTTPChallenge, "disable-http-challenge", certmagic.Default.DisableHTTPChallenge, "Disable the ACME HTTP challenge")
    flag.BoolVar(&certmagic.Default.DisableTLSALPNChallenge, "disable-tls-alpn-challenge", certmagic.Default.DisableTLSALPNChallenge, "Disable the ACME TLS-ALPN challenge")
    flag.StringVar(&certmagic.Default.Email, "email", "", "Default ACME CA account email address")
    flag.DurationVar(&certmagic.HTTPTimeout, "catimeout", certmagic.HTTPTimeout, "Default ACME CA HTTP timeout")
    flag.StringVar(&revoke, "revoke", "", "Hostname for which to revoke the certificate")

  flag.StringVar(&disabledMetrics, "disabled-metrics", "", "Comma-separated list of telemetry metrics to disable")

  flag.StringVar(&conf, "conf", "", "Caddyfile to load (default \""+caddy.DefaultConfigFile+"\")")
    flag.StringVar(&cpu, "cpu", "100%", "CPU cap")
    flag.BoolVar(&printEnv, "env", false, "Enable to print environment variables")
    flag.StringVar(&envFile, "envfile", "", "Path to file with environment variables to load in KEY=VALUE format")

  flag.BoolVar(&fromJSON, "json-to-caddyfile", false, "From JSON stdin to Caddyfile stdout")
    flag.BoolVar(&toJSON, "caddyfile-to-json", false, "From Caddyfile stdin to JSON stdout")
    flag.BoolVar(&plugins, "plugins", false, "List installed plugins")
    flag.StringVar(&logfile, "log", "", "Process log file")
    flag.IntVar(&logRollMB, "log-roll-mb", 100, "Roll process log when it reaches this many megabytes (0 to disable rolling)")
    flag.BoolVar(&logRollCompress, "log-roll-compress", true, "Gzip-compress rolled process log files")
    flag.StringVar(&caddy.PidFile, "pidfile", "", "Path to write pid file")
    flag.BoolVar(&caddy.Quiet, "quiet", false, "Quiet mode (no initialization output)")
    flag.StringVar(&serverType, "type", "http", "Type of server to run")
    flag.BoolVar(&version, "version", false, "Show version")
    flag.BoolVar(&validate, "validate", false, "Parse the Caddyfile but do not start the server")

    caddy.RegisterCaddyfileLoader("flag", caddy.LoaderFunc(confLoader))
    caddy.SetDefaultCaddyfileLoader("default", caddy.LoaderFunc(defaultLoader))
}

然後我們來看 Run() 函式 Run() 函式全文可在最下看到

conf 的靈活設定

conf 用來設定 Caddyfile 的檔案路徑，是可以從 Stdin 即終端輸入配置的。
會在以下兩個在 init() 中的函式呼叫更改

    caddy.RegisterCaddyfileLoader("flag", caddy.LoaderFunc(confLoader))
    caddy.SetDefaultCaddyfileLoader("default", caddy.LoaderFunc(defaultLoader))

而注意到這裡使用的 Loader ，可以用來自定義 caddyfile 的裝載方式。

// confLoader loads the Caddyfile using the -conf flag.
func confLoader(serverType string) (caddy.Input, error) {
    if conf == "" {
        return nil, nil
    }

    if conf == "stdin" {
        return caddy.CaddyfileFromPipe(os.Stdin, serverType)
    }

    var contents []byte
    if strings.Contains(conf, "*") {
        // Let caddyfile.doImport logic handle the globbed path
        contents = []byte("import " + conf)
    } else {
        var err error
        contents, err = ioutil.ReadFile(conf)
        if err != nil {
            return nil, err
        }
    }

    return caddy.CaddyfileInput{
        Contents:       contents,
        Filepath:       conf,
        ServerTypeName: serverType,
    }, nil
}

 注意到這裡返回的 caddy.Input 型別，它代表 caddyfile 在程式中的 structure

Log

log 設定 日誌 輸出在什麼地方，log-roll-mb log-roll-compress 是設定 log 檔案大小限制，達到限制的時候會放棄舊的日誌。還有 檔案的壓縮選項

    // Set up process log before anything bad happens
    switch logfile {
    case "stdout":
        log.SetOutput(os.Stdout)
    case "stderr":
        log.SetOutput(os.Stderr)
    case "":
        log.SetOutput(ioutil.Discard)
    default:
        if logRollMB > 0 {
            log.SetOutput(&lumberjack.Logger{
                Filename:   logfile,
                MaxSize:    logRollMB,
                MaxAge:     14,
                MaxBackups: 10,
                Compress:   logRollCompress,
            })
        } else {
            err := os.MkdirAll(filepath.Dir(logfile), 0755)
            if err != nil {
                mustLogFatalf("%v", err)
            }
            f, err := os.OpenFile(logfile, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
            if err != nil {
                mustLogFatalf("%v", err)
            }
            // don't close file; log should be writeable for duration of process
            log.SetOutput(f)
        }
    }

證照處理

我們看前 8 個 flag 選項，都是設定 TLS 配置的。使用的是 CertMagic ，同時作者也把它放出來可以被其他的 Go 語言程式整合，如果想要為自己的 Go 程式新增 TLS 加密傳輸，就使用它吧。他還支援自動續期，本身是使用的 ACME 客戶端整合。
本身大部分不需要設定，會使用預設設定幫助你啟用 HTTPS 。
介紹一下 revoke 選項，這裡會呼叫 CertMagic 的 Certificate revocation (please, only if private key is compromised)來撤銷證照

// Check for one-time actions
    if revoke != "" {
        err := caddytls.Revoke(revoke)
        if err != nil {
            mustLogFatalf("%v", err)
        }
        fmt.Printf("Revoked certificate for %s\n", revoke)
        os.Exit(0)
    }

telemetry 

然後是 disabled-metrics 選項，用來關閉一些不需要的 遙測指標
注意到這裡的 initTelemetry() 函式，其中會使用 這裡輸入的選項進行遙測的關閉。

// initialize telemetry client
    if EnableTelemetry {
        err := initTelemetry()
        if err != nil {
            mustLogFatalf("[ERROR] Initializing telemetry: %v", err)
        }
    } else if disabledMetrics != "" {
        mustLogFatalf("[ERROR] Cannot disable specific metrics because telemetry is disabled")
    }

然後會在 Run() 的最後部分進行相應遙測模組的 設定

    // Begin telemetry (these are no-ops if telemetry disabled)
    telemetry.Set("caddy_version", module.Version)
    telemetry.Set("num_listeners", len(instance.Servers()))
    telemetry.Set("server_type", serverType)
    telemetry.Set("os", runtime.GOOS)
    telemetry.Set("arch", runtime.GOARCH)
    telemetry.Set("cpu", struct {
        BrandName  string `json:"brand_name,omitempty"`
        NumLogical int    `json:"num_logical,omitempty"`
        AESNI      bool   `json:"aes_ni,omitempty"`
    }{
        BrandName:  cpuid.CPU.BrandName,
        NumLogical: runtime.NumCPU(),
        AESNI:      cpuid.CPU.AesNi(),
    })
    if containerized := detectContainer(); containerized {
        telemetry.Set("container", containerized)
    }
    telemetry.StartEmitting()

環境設定

然後是環境變數的設定 env、envfile，分別是列印出環境資訊和可以設定環境變數檔案的位置

// load all additional envs as soon as possible
    if err := LoadEnvFromFile(envFile); err != nil {
        mustLogFatalf("%v", err)
    }

    if printEnv {
        for _, v := range os.Environ() {
            fmt.Println(v)
        }
    }

cpu

cpu 設定 cpu 使用限制

    // Set CPU cap
    err := setCPU(cpu)
    if err != nil {
        mustLogFatalf("%v", err)
    }

分發事件

這是用來啟用外掛的。

    // Executes Startup events
    caddy.EmitEvent(caddy.StartupEvent, nil)

伺服器型別

type 設定 caddy 啟動的伺服器型別，這是因為 caddy 能啟動的伺服器很多，只要滿足了 Server 的介面就可以使用 caddy。
這裡呼叫的 LoadCaddyfile 可以認為是 Caddy 配置最重要的部分。

    // Get Caddyfile input
    caddyfileinput, err := caddy.LoadCaddyfile(serverType)
    if err != nil {
        mustLogFatalf("%v", err)
    }

pidfile 設定寫入 pid 檔案的路徑， quiet 設定 caddy 不輸出初始化資訊的啟動 。

version 和 plugin 資訊

version 用來顯示 caddy 版本，plugins 用來列出已經安裝的 外掛

    if version {
        if module.Sum != "" {
            // a build with a known version will also have a checksum
            fmt.Printf("Caddy %s (%s)\n", module.Version, module.Sum)
        } else {
            fmt.Println(module.Version)
        }
        os.Exit(0)
    }
    if plugins {
        fmt.Println(caddy.DescribePlugins())
        os.Exit(0)
    }

validate 驗證 caddyfile 檔案

validate 是驗證 caddyfile 的可行性，他會檢測 caddyfile 但是不會啟動一個新的 Server。注意到在這裡呼叫了 os.Exit(0) 退出。

    if validate {
        err := caddy.ValidateAndExecuteDirectives(caddyfileinput, nil, true)
        if err != nil {
            mustLogFatalf("%v", err)
        }
        msg := "Caddyfile is valid"
        fmt.Println(msg)
        log.Printf("[INFO] %s", msg)
        os.Exit(0)
    }

caddyfile 與 JSON

json-to-caddyfile 和caddyfile-to-json 從 JSON 檔案中讀取 caddyfile 的配置檔案，或者將 caddyfile 檔案輸出為 JSON 格式。

    // Check if we just need to do a Caddyfile Convert and exit
    checkJSONCaddyfile()

根據 flag 選項進行 Caddyfile  和 JSON 直接的轉換。

func checkJSONCaddyfile() {
    if fromJSON {
        jsonBytes, err := ioutil.ReadAll(os.Stdin)
        if err != nil {
            fmt.Fprintf(os.Stderr, "Read stdin failed: %v", err)
            os.Exit(1)
        }
        caddyfileBytes, err := caddyfile.FromJSON(jsonBytes)
        if err != nil {
            fmt.Fprintf(os.Stderr, "Converting from JSON failed: %v", err)
            os.Exit(2)
        }
        fmt.Println(string(caddyfileBytes))
        os.Exit(0)
    }
    if toJSON {
        caddyfileBytes, err := ioutil.ReadAll(os.Stdin)
        if err != nil {
            fmt.Fprintf(os.Stderr, "Read stdin failed: %v", err)
            os.Exit(1)
        }
        jsonBytes, err := caddyfile.ToJSON(caddyfileBytes)
        if err != nil {
            fmt.Fprintf(os.Stderr, "Converting to JSON failed: %v", err)
            os.Exit(2)
        }
        fmt.Println(string(jsonBytes))
        os.Exit(0)
    }
}

Start

啟動伺服器

    // Start your engines
    instance, err := caddy.Start(caddyfileinput)
    if err != nil {
        mustLogFatalf("%v", err)
    }

總結

看完 caddy 的 run 函式，瞭解了程式的啟動配置了哪些東西，相應的會有一些問題。帶著這些問題繼續看原始碼，能夠深入瞭解 caddy 內的邏輯。

• caddy.Input 的內在讀取 caddyfile 的操作
• Loader 可以看出也是可以自定義的，他實際涉及到 Caddy 較為重要的 接收配置，安裝配置的操作部分。它會讀取 token 給 plugin 配置時 給 controller 消費，這裡多的名詞是來自於 caddy 的配置部分
• caddy.EmitEvent 是怎樣啟動各 caddy 外掛的
• caddy.ServerType 除了 HTTP 還有什麼（外掛會對應相應的伺服器的）
• instance 可以看出是 caddy 伺服器的例項，它具體的設定邏輯是什麼來獲得 外掛裝配的能力的。他是怎樣作為伺服器服務的
• 遙測模組的接入（caddy 2已經不用了）
• 其他的就是一些方便的選項了。

附件

Run() 函式原始碼

// Run is Caddy's main() function.
func Run() {
    flag.Parse()

    module := getBuildModule()
    cleanModVersion := strings.TrimPrefix(module.Version, "v")

    caddy.AppName = appName
    caddy.AppVersion = module.Version
    certmagic.UserAgent = appName + "/" + cleanModVersion

    // Set up process log before anything bad happens
    switch logfile {
    case "stdout":
        log.SetOutput(os.Stdout)
    case "stderr":
        log.SetOutput(os.Stderr)
    case "":
        log.SetOutput(ioutil.Discard)
    default:
        if logRollMB > 0 {
            log.SetOutput(&lumberjack.Logger{
                Filename:   logfile,
                MaxSize:    logRollMB,
                MaxAge:     14,
                MaxBackups: 10,
                Compress:   logRollCompress,
            })
        } else {
            err := os.MkdirAll(filepath.Dir(logfile), 0755)
            if err != nil {
                mustLogFatalf("%v", err)
            }
            f, err := os.OpenFile(logfile, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
            if err != nil {
                mustLogFatalf("%v", err)
            }
            // don't close file; log should be writeable for duration of process
            log.SetOutput(f)
        }
    }

    // load all additional envs as soon as possible
    if err := LoadEnvFromFile(envFile); err != nil {
        mustLogFatalf("%v", err)
    }

    if printEnv {
        for _, v := range os.Environ() {
            fmt.Println(v)
        }
    }

    // initialize telemetry client
    if EnableTelemetry {
        err := initTelemetry()
        if err != nil {
            mustLogFatalf("[ERROR] Initializing telemetry: %v", err)
        }
    } else if disabledMetrics != "" {
        mustLogFatalf("[ERROR] Cannot disable specific metrics because telemetry is disabled")
    }

    // Check for one-time actions
    if revoke != "" {
        err := caddytls.Revoke(revoke)
        if err != nil {
            mustLogFatalf("%v", err)
        }
        fmt.Printf("Revoked certificate for %s\n", revoke)
        os.Exit(0)
    }
    if version {
        if module.Sum != "" {
            // a build with a known version will also have a checksum
            fmt.Printf("Caddy %s (%s)\n", module.Version, module.Sum)
        } else {
            fmt.Println(module.Version)
        }
        os.Exit(0)
    }
    if plugins {
        fmt.Println(caddy.DescribePlugins())
        os.Exit(0)
    }

    // Check if we just need to do a Caddyfile Convert and exit
    checkJSONCaddyfile()

    // Set CPU cap
    err := setCPU(cpu)
    if err != nil {
        mustLogFatalf("%v", err)
    }

    // Executes Startup events
    caddy.EmitEvent(caddy.StartupEvent, nil)

    // Get Caddyfile input
    caddyfileinput, err := caddy.LoadCaddyfile(serverType)
    if err != nil {
        mustLogFatalf("%v", err)
    }

    if validate {
        err := caddy.ValidateAndExecuteDirectives(caddyfileinput, nil, true)
        if err != nil {
            mustLogFatalf("%v", err)
        }
        msg := "Caddyfile is valid"
        fmt.Println(msg)
        log.Printf("[INFO] %s", msg)
        os.Exit(0)
    }

    // Log Caddy version before start
    log.Printf("[INFO] Caddy version: %s", module.Version)

    // Start your engines
    instance, err := caddy.Start(caddyfileinput)
    if err != nil {
        mustLogFatalf("%v", err)
    }

    // Begin telemetry (these are no-ops if telemetry disabled)
    telemetry.Set("caddy_version", module.Version)
    telemetry.Set("num_listeners", len(instance.Servers()))
    telemetry.Set("server_type", serverType)
    telemetry.Set("os", runtime.GOOS)
    telemetry.Set("arch", runtime.GOARCH)
    telemetry.Set("cpu", struct {
        BrandName  string `json:"brand_name,omitempty"`
        NumLogical int    `json:"num_logical,omitempty"`
        AESNI      bool   `json:"aes_ni,omitempty"`
    }{
        BrandName:  cpuid.CPU.BrandName,
        NumLogical: runtime.NumCPU(),
        AESNI:      cpuid.CPU.AesNi(),
    })
    if containerized := detectContainer(); containerized {
        telemetry.Set("container", containerized)
    }
    telemetry.StartEmitting()

    // Twiddle your thumbs
    instance.Wait()
}

擴充閱讀

caddy（二）啟動流程
Caddy原始碼閱讀（三）Caddyfile 解析 by Loader & Parser
Caddy原始碼閱讀（四）Plugin & Controller 安裝外掛
Caddy原始碼閱讀（五） Instance & Server
caddy-plugins（一）自定義外掛
caddy-plugins（二）caddy-grpc 一個外掛例項

本作品採用《CC 協議》，轉載必須註明作者和本文連結