vtcode-auth 0.173.0

Authentication and OAuth flows shared across VT Code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# vtcode-auth

`vtcode-auth` provides authentication and OAuth flows shared across VT Code.

It contains:

- OAuth login flows for OpenAI ChatGPT, OpenRouter, and MCP servers
- A local callback server (`axum`-based) for receiving OAuth authorization codes
- PKCE challenge generation for secure OAuth exchanges
- Credential storage backed by the OS keyring and on-disk fallback

<!-- cargo-rdme start -->

Shared authentication and OAuth flows for VT Code.

<!-- cargo-rdme end -->

## Usage

Add the dependency to your `Cargo.toml`:

```toml
[dependencies]
vtcode-auth = { path = "../vtcode-auth" }
```

```rust
use vtcode_auth::{AuthConfig, CredentialStorage, PkceChallenge, OAuthProvider};

// Generate a PKCE challenge for an OAuth flow
let challenge = vtcode_auth::generate_pkce_challenge();

// Start the local callback server for a provider
let server = vtcode_auth::start_auth_code_callback_server(OAuthProvider::OpenRouter).await?;
```

## API Reference

See [docs.rs/vtcode-auth](https://docs.rs/vtcode-auth) for full API documentation.

| Type                     | Purpose                                         |
| ------------------------ | ----------------------------------------------- |
| `AuthConfig`             | Top-level authentication configuration          |
| `CopilotAuthConfig`      | Copilot-specific auth settings                  |
| `OpenAIAuthConfig`       | OpenAI-specific auth settings                   |
| `CredentialStorage`      | Read/write credentials via OS keyring or file   |
| `CustomApiKeyStorage`    | Store and retrieve user-provided API keys       |
| `McpOAuthService`        | Drive the MCP OAuth login flow                  |
| `AuthCodeCallbackServer` | Local HTTP server that captures OAuth callbacks |
| `OAuthProvider`          | Enum of supported OAuth providers               |
| `PkceChallenge`          | PKCE code-verifier / code-challenge pair        |

## Public entrypoints

- `credentials` — credential storage, migration, and custom API-key helpers
- `mcp_oauth` — MCP-server OAuth login lifecycle
- `oauth_server` — local callback server and provider definitions
- `openai_chatgpt_oauth` — OpenAI ChatGPT OAuth session management
- `openrouter_oauth` — OpenRouter OAuth token management
- `pkce` — PKCE challenge generation

## Related docs

- [Architecture overview](../docs/ARCHITECTURE.md)