STM32F4-Base/test/host/ftp_auth/ftp_auth_test.c

/*
 * 模块名称：FTP 鉴权状态机（lftpd_auth）主机侧单元测试
 * 模块功能：在 PC 上对 Drivers/BSP/NET/lftpd/lftpd_auth.c 做离线验证
 *           （用户名匹配 / 口令校验 / 失败计数 / 限时锁定 / tick 回绕）。
 *
 * 被测对象：真实源文件 lftpd_auth.c + 其依赖 sha256.c（均以 #include 原样
 *           纳入，保证测的是生产代码而非副本；两模块零平台依赖，无需桩——
 *           tick 由参数注入正是本模块的纯函数设计意图）。
 *
 * 为什么要主机侧单测（而不是只用台架）：
 *   锁定 60 s / 解锁 / 成功清零 / tick 32 位回绕是"防口令爆破"契约的核心，
 *   板端每验一条要真等 60 s 且回绕要跑满 49.7 天；主机侧注入合成 tick
 *   毫秒级穷举。用户名侧信道路径（错用户名也走哈希）同属纯逻辑。
 *
 * 覆盖点：
 *   TC-FTPAUTH-001 user_match：相等 / 大小写不敏感 / 不等 / NULL
 *   TC-FTPAUTH-002 正确用户名+正确口令 → OK，计数 0
 *   TC-FTPAUTH-003 错口令 → FAIL，计数 1
 *   TC-FTPAUTH-004 错用户名+对口令 → FAIL（哈希路径已走，时间拉平）
 *   TC-FTPAUTH-005 连续 5 次失败 → 第 6 次（锁定期内）LOCKED，对口令也拒
 *   TC-FTPAUTH-006 锁定期满（+60000 tick）→ 对口令 OK，计数清零
 *   TC-FTPAUTH-007 成功清零计数：3 败 + 1 成 → 再 4 败不触发锁定（第 5 败才锁）
 *   TC-FTPAUTH-008 tick 32 位回绕：锁定期内回绕点仍 LOCKED，期满回绕点放行
 *   TC-FTPAUTH-009 配置 pwd_hash 非法 hex → 恒 FAIL（fail-closed）
 *   TC-FTPAUTH-010 空口令 / NULL 口令 → FAIL；NULL creds/state → FAIL
 *
 * 通过：全部 TC PASS（main 返回 0）。
 * 入口：int main(void)，返回 0=PASS / 1=FAIL（由 run 脚本判读）。
 *
 * 创建日期：2026-10-11
 */

#include <stdio.h>
#include <string.h>

/* 生产源文件原样纳入（顺序敏感：先 sha256 后 lftpd_auth） */
#include "sha256.c"
#include "lftpd_auth.c"

/* ===================== 断言框架 ===================== */

static int s_total;
static int s_passed;
static int s_failed;

#define CHECK(cond, name) do { \
    s_total++; \
    if (cond) { s_passed++; printf("  PASS %s\n", name); } \
    else { s_failed++; printf("  FAIL %s (line %d)\n", name, __LINE__); } \
} while (0)

/* 与 ftp_cfg.h FTP_CFG_DEF_HASH 同源钉值（SHA256("adminadmin")） */
#define DEF_HASH  "d82494f05d6917ba02f7aaa29689ccb444bb73f20380876cb05d1f37537b7892"

static const ftp_auth_creds_t s_creds = { "admin", DEF_HASH, 1u };

/* ===================== TC-FTPAUTH-001：user_match ===================== */

static void tc_user_match(void)
{
    CHECK(ftp_auth_user_match("admin", "admin") == 1, "TC-FTPAUTH-001a equal strings match");
    CHECK(ftp_auth_user_match("admin", "ADMIN") == 1, "TC-FTPAUTH-001b case-insensitive");
    CHECK(ftp_auth_user_match("admin", "root") == 0, "TC-FTPAUTH-001c mismatch rejected");
    CHECK(ftp_auth_user_match("admin", "admin2") == 0, "TC-FTPAUTH-001d prefix does not count as match");
    CHECK(ftp_auth_user_match("admin", NULL) == 0, "TC-FTPAUTH-001e NULL rejected");
}

/* ===================== TC-FTPAUTH-002..004：基本判定 ===================== */

static void tc_basic(void)
{
    ftp_auth_state_t st;

    (void)memset(&st, 0, sizeof(st));
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st, 1000u) == FTP_AUTH_OK,
          "TC-FTPAUTH-002 right user + right password -> OK");
    CHECK(st.fail_count == 0u, "TC-FTPAUTH-002b counter is 0 after success");

    (void)memset(&st, 0, sizeof(st));
    CHECK(ftp_auth_check(&s_creds, 1u, "wrong", &st, 1000u) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-003 wrong password -> FAIL");
    CHECK(st.fail_count == 1u, "TC-FTPAUTH-003b fail count = 1");

    (void)memset(&st, 0, sizeof(st));
    CHECK(ftp_auth_check(&s_creds, 0u, "admin", &st, 1000u) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-004 wrong user + right password -> FAIL (hash path taken)");
}

/* ===================== TC-FTPAUTH-005..006：锁定与解锁 ===================== */

static void tc_lock(void)
{
    ftp_auth_state_t st;
    uint32_t t = 10000u;

    (void)memset(&st, 0, sizeof(st));
    for (int i = 0; i < 5; i++) {
        CHECK(ftp_auth_check(&s_creds, 1u, "wrong", &st, t) == FTP_AUTH_FAIL,
              "TC-FTPAUTH-005 attempts 1..5 -> FAIL");
    }
    CHECK(st.fail_count == 5u, "TC-FTPAUTH-005b counter reaches FAIL_MAX");
    /* 锁定期内：对口令也 LOCKED，且不再计数 */
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st, t + 1u) == FTP_AUTH_LOCKED,
          "TC-FTPAUTH-005c right password during lock window -> LOCKED");
    CHECK(st.fail_count == 5u, "TC-FTPAUTH-005d LOCKED does not change the counter");
    /* 59999 tick：仍在窗内（差值 < 60000） */
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st,
                         st.lock_until_tick - 1u) == FTP_AUTH_LOCKED,
          "TC-FTPAUTH-005e last tick inside window still LOCKED");
    /* 期满：恰好到达 lock_until → 放行 */
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st,
                         st.lock_until_tick) == FTP_AUTH_OK,
          "TC-FTPAUTH-006 right password after lock expiry -> OK");
    CHECK(st.fail_count == 0u, "TC-FTPAUTH-006b counter cleared after unlock then success");
}

/* ===================== TC-FTPAUTH-007：成功清零计数 ===================== */

static void tc_reset(void)
{
    ftp_auth_state_t st;
    uint32_t t = 5000u;

    (void)memset(&st, 0, sizeof(st));
    for (int i = 0; i < 3; i++) {
        (void)ftp_auth_check(&s_creds, 1u, "wrong", &st, t);
    }
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st, t) == FTP_AUTH_OK,
          "TC-FTPAUTH-007a success after 3 failures -> OK");
    CHECK(st.fail_count == 0u, "TC-FTPAUTH-007b success clears the counter");
    for (int i = 0; i < 4; i++) {
        CHECK(ftp_auth_check(&s_creds, 1u, "wrong", &st, t) == FTP_AUTH_FAIL,
              "TC-FTPAUTH-007c after clear, 4 more failures still FAIL (not locked)");
    }
    CHECK(ftp_auth_check(&s_creds, 1u, "wrong", &st, t) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-007d 5th failure FAILs and arms the lock");
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st, t + 1u) == FTP_AUTH_LOCKED,
          "TC-FTPAUTH-007e LOCKED after 5 consecutive failures");
}

/* ===================== TC-FTPAUTH-008：tick 32 位回绕 ===================== */

static void tc_wraparound(void)
{
    ftp_auth_state_t st;

    /* 手工构造：锁定截止在 0xFFFFFFF0（距 32 位翻转仅 16 tick） */
    (void)memset(&st, 0, sizeof(st));
    st.fail_count = 5u;
    st.lock_until_tick = 0xFFFFFFF0u;
    /* 回绕前 240 tick：仍在窗内 */
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st, 0xFFFFFF00u) == FTP_AUTH_LOCKED,
          "TC-FTPAUTH-008a inside window before wraparound -> LOCKED");
    /* 回绕后 32 tick：now=0x10，(int32_t)(0x10-0xFFFFFFF0)=+32 → 期满 */
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", &st, 0x00000010u) == FTP_AUTH_OK,
          "TC-FTPAUTH-008b after wraparound window elapsed -> OK (signed diff resists wraparound)");
}

/* ===================== TC-FTPAUTH-009..010：fail-closed 边界 ===================== */

static void tc_fail_closed(void)
{
    ftp_auth_state_t st;
    ftp_auth_creds_t bad_creds = { "admin", "zz2494f05d6917ba02f7aaa29689ccb444bb73f20380876cb05d1f37537b7892", 1u };

    (void)memset(&st, 0, sizeof(st));
    CHECK(ftp_auth_check(&bad_creds, 1u, "admin", &st, 1000u) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-009 invalid hex config -> always FAIL (nobody can log in, fail-closed)");

    (void)memset(&st, 0, sizeof(st));
    CHECK(ftp_auth_check(&s_creds, 1u, "", &st, 1000u) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-010a empty password -> FAIL");
    CHECK(ftp_auth_check(&s_creds, 1u, NULL, &st, 1000u) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-010b NULL password -> FAIL");
    CHECK(ftp_auth_check(NULL, 1u, "admin", &st, 1000u) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-010c NULL creds -> FAIL");
    CHECK(ftp_auth_check(&s_creds, 1u, "admin", NULL, 1000u) == FTP_AUTH_FAIL,
          "TC-FTPAUTH-010d NULL state -> FAIL");
}

/* ===================== main ===================== */

int main(void)
{
    printf("=== FTP Auth Tests ===\n");

    printf("-- user match --\n");
    tc_user_match();
    printf("-- basic check --\n");
    tc_basic();
    printf("-- lock / unlock --\n");
    tc_lock();
    printf("-- success reset --\n");
    tc_reset();
    printf("-- tick wraparound --\n");
    tc_wraparound();
    printf("-- fail-closed --\n");
    tc_fail_closed();

    printf("\n=== FTP Auth Tests: %d/%d PASSED (failed=%d) ===\n",
           s_passed, s_total, s_failed);
    return (s_failed == 0) ? 0 : 1;
}