Octokit.NET 身份验证失败问题分析与解决方案

问题背景

在使用 Octokit.NET 13.0.1 版本时，开发者遇到了一个常见的身份验证问题。当尝试通过用户名和密码访问 GitHub 仓库时，系统会抛出 Octokit.NotFoundException 异常。这实际上是一个身份验证失败的表现，而非真正的"未找到"错误。

核心问题

自2021年8月起，GitHub 已全面停止支持基于密码的 API 认证方式。这是 GitHub 加强安全措施的一部分，旨在减少密码泄露风险。因此，任何尝试使用传统用户名/密码组合进行认证的请求都会失败。

解决方案：使用个人访问令牌(PAT)

1. 生成个人访问令牌

开发者需要在 GitHub 账户设置中创建个人访问令牌：

1. 登录 GitHub 账户
2. 进入开发者设置
3. 选择"个人访问令牌"选项
4. 创建新令牌并设置适当的权限范围

2. 代码修改

原代码中的认证部分需要修改为使用令牌认证：

var ghClient = new GitHubClient(new ProductHeaderValue("Octokit"));
ghClient.Credentials = new Credentials("your_personal_access_token");

3. 安全注意事项

• 令牌应妥善保管，不要直接硬编码在源代码中
• 建议使用环境变量或安全存储来管理令牌
• 为不同应用创建不同的令牌，并设置最小必要权限

完整示例代码

async public Task UpdateGithub()
{
    var ghClient = new GitHubClient(new ProductHeaderValue("Octokit"));
    ghClient.Credentials = new Credentials("your_personal_access_token");

    var owner = "owner";
    var repo = "repo.github.io";
    var branch = "main";
    var targetFile = "test.txt";

    try
    {
        var existingFile = await ghClient.Repository.Content.GetAllContentsByRef(owner, repo, targetFile, branch);
        var updateChangeSet = await ghClient.Repository.Content.UpdateFile(
            owner, 
            repo, 
            targetFile, 
            new UpdateFileRequest("API File update", "Hello Universe! " + DateTime.UtcNow, existingFile.First().Sha, branch));
    }
    catch (Octokit.NotFoundException)
    {
        var createChangeSet = await ghClient.Repository.Content.CreateFile(
            owner, 
            repo, 
            targetFile, 
            new CreateFileRequest("API File creation", "Hello Universe! " + DateTime.UtcNow, branch));
    }
}

进阶建议

1. 错误处理优化：除了 NotFoundException，还应处理其他可能的异常如 AuthorizationException
2. 令牌管理：考虑使用 GitHub Actions 密钥或 Azure Key Vault 等安全方案管理令牌
3. 权限控制：为令牌仅授予必要的仓库权限，通常"repo"权限就足够

通过以上修改，开发者可以顺利使用 Octokit.NET 库与 GitHub 进行交互，同时遵循了最佳安全实践。