Skip to content

oauth: out_http: add user-agent option for oauth #11830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rja5 wants to merge 4 commits into
base: master
Choose a base branch
from
+147 −4
Open

oauth: out_http: add user-agent option for oauth #11830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b21522
oauth2: Add user-agent member field
rja5 May 25, 2026
5b70c00
out_http: Add capability to handle user_agent option
rja5 May 25, 2026
63c80b4
tests: oauth2: add user-agent tests
rja5 May 25, 2026
e51a512
oauth2: Add user-agent member field
rja5 May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions include/fluent-bit/flb_oauth2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ struct flb_oauth2_config {
flb_sds_t token_url;
flb_sds_t client_id;
flb_sds_t client_secret;
flb_sds_t user_agent;
flb_sds_t scope;
flb_sds_t audience;
flb_sds_t resource;
Expand Down
5 changes: 5 additions & 0 deletions plugins/out_http/http.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -743,6 +743,11 @@ static struct flb_config_map config_map[] = {
0, FLB_TRUE, offsetof(struct flb_out_http, oauth2_config.client_secret),
"OAuth2 client_secret"
},
{
FLB_CONFIG_MAP_STR, "oauth2.user_agent", NULL,
0, FLB_TRUE, offsetof(struct flb_out_http, oauth2_config.user_agent),
"Optional User-Agent header for OAuth2 token requests"
},
{
FLB_CONFIG_MAP_STR, "oauth2.scope", NULL,
0, FLB_TRUE, offsetof(struct flb_out_http, oauth2_config.scope),
Expand Down
25 changes: 25 additions & 0 deletions src/flb_oauth2.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ struct flb_config_map oauth2_config_map[] = {
0, FLB_TRUE, offsetof(struct flb_oauth2_config, client_secret),
"OAuth2 client_secret"
},
{
FLB_CONFIG_MAP_STR, "oauth2.user_agent", NULL,
0, FLB_TRUE, offsetof(struct flb_oauth2_config, user_agent),
"Optional User-Agent header for OAuth2 token requests"
},
{
FLB_CONFIG_MAP_STR, "oauth2.scope", NULL,
0, FLB_TRUE, offsetof(struct flb_oauth2_config, scope),
Expand Down Expand Up @@ -185,6 +190,7 @@ static void oauth2_apply_defaults(struct flb_oauth2_config *cfg)
cfg->token_url = NULL;
cfg->client_id = NULL;
cfg->client_secret = NULL;
cfg->user_agent = NULL;
cfg->scope = NULL;
cfg->audience = NULL;
cfg->resource = NULL;
Expand Down Expand Up @@ -243,6 +249,15 @@ static int oauth2_clone_config(struct flb_oauth2_config *dst,
}
}

if (src->user_agent) {
dst->user_agent = flb_sds_create(src->user_agent);
if (!dst->user_agent) {
flb_errno();
flb_oauth2_config_destroy(dst);
return -1;
}
}

if (src->scope) {
dst->scope = flb_sds_create(src->scope);
if (!dst->scope) {
Expand Down Expand Up @@ -324,6 +339,8 @@ void flb_oauth2_config_destroy(struct flb_oauth2_config *cfg)
cfg->client_id = NULL;
flb_sds_destroy(cfg->client_secret);
cfg->client_secret = NULL;
flb_sds_destroy(cfg->user_agent);
cfg->user_agent = NULL;
flb_sds_destroy(cfg->scope);
cfg->scope = NULL;
flb_sds_destroy(cfg->audience);
Expand Down Expand Up @@ -1114,6 +1131,14 @@ static int oauth2_http_request(struct flb_oauth2 *ctx, flb_sds_t body)
FLB_OAUTH2_HTTP_ENCODING,
sizeof(FLB_OAUTH2_HTTP_ENCODING) - 1);

if (ctx->cfg.user_agent) {
flb_http_add_header(c,
"User-Agent",
10,
ctx->cfg.user_agent,
flb_sds_len(ctx->cfg.user_agent));
}

if (ctx->cfg.auth_method == FLB_OAUTH2_AUTH_METHOD_BASIC &&
ctx->cfg.client_id && ctx->cfg.client_secret) {
ret = flb_http_basic_auth(c, ctx->cfg.client_id, ctx->cfg.client_secret);
Expand Down
120 changes: 116 additions & 4 deletions tests/internal/oauth2.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ struct oauth2_mock_server {
int expires_in;
char latest_token[64];
char latest_token_request[MOCK_BODY_SIZE];
int token_user_agent_seen;
char token_user_agent[256];
pthread_t thread;
#ifdef _WIN32
int wsa_initialized;
Expand Down Expand Up @@ -152,9 +154,45 @@ static int request_content_length(const char *request)
return len;
}

static int request_header_value(const char *request, const char *header_name,
char *out, size_t out_size)
{
int header_len;
const char *end;
const char *start;
size_t value_len;

start = strstr(request, header_name);
if (!start) {
return -1;
}

header_len = strlen(header_name);
start += header_len;
while (*start == ' ') {
start++;
}

end = strstr(start, "\r\n");
if (!end) {
return -1;
}

value_len = end - start;
if (value_len >= out_size) {
return -1;
}

memcpy(out, start, value_len);
out[value_len] = '\0';

return 0;
}

static void handle_token_request(struct oauth2_mock_server *server, flb_sockfd_t fd,
const char *request)
{
int ret;
char payload[MOCK_BODY_SIZE];
char *body;
size_t body_len;
Expand All @@ -163,6 +201,16 @@ static void handle_token_request(struct oauth2_mock_server *server, flb_sockfd_t
snprintf(server->latest_token, sizeof(server->latest_token),
"mock-token-%d", server->token_requests);

server->token_user_agent_seen = FLB_FALSE;
server->token_user_agent[0] = '\0';
ret = request_header_value(request,
"User-Agent:",
server->token_user_agent,
sizeof(server->token_user_agent));
if (ret == 0) {
server->token_user_agent_seen = FLB_TRUE;
}

body = strstr(request, "\r\n\r\n");
if (body) {
body += 4;
Expand Down Expand Up @@ -464,11 +512,13 @@ static void oauth2_mock_server_stop(struct oauth2_mock_server *server)
#endif
}

static struct flb_oauth2 *create_oauth_ctx(struct flb_config *config,
struct oauth2_mock_server *server,
int refresh_skew)
static struct flb_oauth2 *create_oauth_ctx_with_user_agent(struct flb_config *config,
struct oauth2_mock_server *server,
int refresh_skew,
const char *user_agent)
{
struct flb_oauth2_config cfg;
struct flb_oauth2 *ctx;

memset(&cfg, 0, sizeof(cfg));
cfg.enabled = FLB_TRUE;
Expand All @@ -477,16 +527,77 @@ static struct flb_oauth2 *create_oauth_ctx(struct flb_config *config,
cfg.refresh_skew = refresh_skew;
cfg.client_id = flb_sds_create("id");
cfg.client_secret = flb_sds_create("secret");
if (user_agent) {
cfg.user_agent = flb_sds_create(user_agent);
}

flb_sds_printf(&cfg.token_url, "http://127.0.0.1:%d/token", server->port);

struct flb_oauth2 *ctx = flb_oauth2_create_from_config(config, &cfg);
ctx = flb_oauth2_create_from_config(config, &cfg);

flb_oauth2_config_destroy(&cfg);

return ctx;
}

static struct flb_oauth2 *create_oauth_ctx(struct flb_config *config,
struct oauth2_mock_server *server,
int refresh_skew)
{
return create_oauth_ctx_with_user_agent(config, server, refresh_skew, NULL);
}

void test_user_agent_header_optional(void)
{
int ret;
flb_sds_t token = NULL;
struct flb_config *config;
struct flb_oauth2 *ctx;
struct oauth2_mock_server server;

config = flb_config_init();
TEST_CHECK(config != NULL);

ret = oauth2_mock_server_start(&server, 3600, 0);
TEST_CHECK(ret == 0);

ctx = create_oauth_ctx(config, &server, 58);
TEST_CHECK(ctx != NULL);

#ifdef FLB_SYSTEM_MACOS
ret = oauth2_mock_server_wait_ready(&server);
TEST_CHECK(ret == 0);
#endif

ret = flb_oauth2_get_access_token(ctx, &token, FLB_FALSE);
TEST_CHECK(ret == 0);
TEST_CHECK(server.token_user_agent_seen == FLB_FALSE);

flb_oauth2_destroy(ctx);
oauth2_mock_server_stop(&server);

ret = oauth2_mock_server_start(&server, 3600, 0);
TEST_CHECK(ret == 0);

ctx = create_oauth_ctx_with_user_agent(config, &server, 58,
"oauth2-agent-test/1.0");
TEST_CHECK(ctx != NULL);

#ifdef FLB_SYSTEM_MACOS
ret = oauth2_mock_server_wait_ready(&server);
TEST_CHECK(ret == 0);
#endif

ret = flb_oauth2_get_access_token(ctx, &token, FLB_FALSE);
TEST_CHECK(ret == 0);
TEST_CHECK(server.token_user_agent_seen == FLB_TRUE);
TEST_CHECK(strcmp(server.token_user_agent, "oauth2-agent-test/1.0") == 0);

flb_oauth2_destroy(ctx);
oauth2_mock_server_stop(&server);
flb_config_exit(config);
}

static struct flb_oauth2 *create_legacy_oauth_ctx(struct flb_config *config,
struct oauth2_mock_server *server)
{
Expand Down Expand Up @@ -1149,6 +1260,7 @@ TEST_LIST = {
test_parse_rejects_missing_required_fields},
{"parse_rejects_invalid_expires_in", test_parse_rejects_invalid_expires_in},
{"caching_and_refresh", test_caching_and_refresh},
{"user_agent_header_optional", test_user_agent_header_optional},
{"legacy_create_manual_payload_flow", test_legacy_create_manual_payload_flow},
{"private_key_jwt_body", test_private_key_jwt_body},
{"private_key_jwt_x5t_header", test_private_key_jwt_x5t_header},
Expand Down
Loading