LEClient 开源项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00535/article/details/141586788

LEClient 开源项目使用教程

LEClientAn easy-to-use PHP ACME v2 client library, designed to be used with LetsEncrypt.项目地址:https://gitcode.com/gh_mirrors/le/LEClient

1. 项目的目录结构及介绍

LEClient 是一个用于与 LetsEncrypt 进行交互的 PHP ACME v2 客户端库。项目的目录结构如下：

LEClient/
├── src/
│   ├── LEAccount.php
│   ├── LEClient.php
│   ├── LEOrder.php
│   ├── Exception/
│   │   ├── LEClientException.php
│   │   ├── LEAccountException.php
│   │   ├── LEOrderException.php
│   ├── ACMEv2/
│   │   ├── ACMEv2.php
│   │   ├── ACMEv2Exception.php
├── examples/
│   ├── example.php
├── tests/
│   ├── LEClientTest.php
├── README.md
├── composer.json
├── composer.lock

目录结构介绍

src/：包含项目的主要源代码文件。
- LEAccount.php：处理账户相关的操作。
- LEClient.php：主客户端类，用于与 LetsEncrypt 进行交互。
- LEOrder.php：处理订单相关的操作。
- Exception/：包含自定义异常类。
- ACMEv2/：包含 ACME v2 协议相关的类。
examples/：包含示例代码文件。
- example.php：一个简单的使用示例。
tests/：包含测试代码文件。
- LEClientTest.php：用于测试 LEClient 类的功能。
README.md：项目说明文档。
composer.json 和 composer.lock：Composer 依赖管理文件。

2. 项目的启动文件介绍

项目的启动文件是 examples/example.php。这个文件提供了一个简单的示例，展示了如何使用 LEClient 类与 LetsEncrypt 进行交互。

启动文件内容

<?php
require_once __DIR__ . '/../vendor/autoload.php';

use LEClient\LEClient;
use LEClient\LEOrder;

// 配置信息
$email = 'your-email@example.com';
$domain = 'your-domain.com';

// 创建客户端实例
$client = new LEClient($email, LEClient::LE_PRODUCTION);

// 创建订单
$order = $client->getOrCreateOrder($domain, [$domain]);

// 验证域名
$order->verifyPendingOrderDomains();

// 下载证书
if ($order->allAuthorizationsValid()) {
    $order->finalizeOrder();
    if ($order->isFinalized()) {
        $order->getCertificate();
    }
}

启动文件介绍

首先引入 Composer 自动加载文件。
使用 LEClient 类创建一个客户端实例，并传入邮箱地址和环境类型（生产环境或测试环境）。
使用 getOrCreateOrder 方法创建一个订单，并传入域名和域名列表。
调用 verifyPendingOrderDomains 方法验证域名。
如果所有域名验证通过，调用 finalizeOrder 方法完成订单，并下载证书。

3. 项目的配置文件介绍

项目的配置文件是 composer.json，它定义了项目的依赖和其他配置信息。

配置文件内容

{
    "name": "yourivw/leclient",
    "description": "An easy-to-use PHP ACME v2 client library, designed to be used with LetsEncrypt.",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "Yuri Volkov",
            "email": "yuri.volkov@gmail.com"
        }
    ],
    "require": {
        "php": ">=7.1",
        "guzzlehttp/guzzle": "^6.3"
    },
    "autoload": {
        "psr-4": {
            "LEClient\\": "src/"
        }
    }
}