Could not contain "@" and ":" in API Key

[potofo]

Which API Provider are you using?

OpenAI Compatible

Which Model are you using?

Azure OpenAI gpt-4o

What happened?

In the API Provider settings of Roo-Cline, if you select OpenAI Compatible and the API key set in the custom extended API relay server contains ':' or '@', the API key will not propagate to the API relay server.
I tried URL encoding ":" and "@", but the result was the same.
You cannot remove ":" or "@" from the API key.
I can't read TypeScript, so I can't analyze the code.

Does anyone know a good way to solve this problem?

Steps to reproduce

1.Open Setting of Roo-Cline
2.Select OpenAI Compatible to API Provider
3.set API Key contain "@" and ":"
4.API Request Failed error occurred.

API Request Failed
401 Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription and use a correct regional API endpoint for your resource.

5.Confirm Log
When I confirm the API relay server log, the API key was empty.

Relevant API REQUEST output

API Request Failed 
401 Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription and use a correct regional API endpoint for your resource.

Additional context

No response

[mrubens]

Hmm... and you're positive that the endpoint and key are correct?

[potofo]

Thank you for comments,
My API Provider settings are as follows.
The difference from the working configuration is

1. The domain of the base URL is azurewebsites.net instead of openai.azure.com
2. The API key contains the characters @ and :

When I used Roo-Cline to investigate the API key check of Roo-Cline, I was instructed to fix the attached part, but do you know if this code may be affecting it?

API Provider
OpenAI Compatible
Base URL
https://hogehoge.azurewebsites.net/openai/deployments/gpt-4o-mini/chat/completions?api-version=2024-08-01-preview
API Key (Contain @ and : character)
hogehoge@hogepage.com:xxxxxxxxxxxxxxxxxxxxxxxxx
Default Model
gpt-4o-mini
Set Azure API version
2024-08-01-preview

Note:
1.hogehoge.azurewebsites.net is Gateway of Azure OpenAI

[mrubens]

Thank you for comments, My API Provider settings are as follows. The difference from the working configuration is

1. The domain of the base URL is azurewebsites.net instead of openai.azure.com
2. The API key contains the characters @ and :

When I used Roo-Cline to investigate the API key check of Roo-Cline, I was instructed to fix the attached part, but do you know if this code may be affecting it?

API Provider OpenAI Compatible Base URL https://hogehoge.azurewebsites.net/openai/deployments/gpt-4o-mini/chat/completions?api-version=2024-08-01-preview API Key (Contain @ and : character) hogehoge@hogepage.com:xxxxxxxxxxxxxxxxxxxxxxxxx Default Model gpt-4o-mini Set Azure API version 2024-08-01-preview

Note: 1.hogehoge.azurewebsites.net is Gateway of Azure OpenAI

Hmm I just put a breakpoint there as well and confirmed that I could storeSecret and getSecret with an @ in the key. The only thing I can think of is some escaping happening before that? 🤔

[potofo]

I also thought that I needed to escape symbols, so I tried URL encoding, but it seems that the URL encoding wasn't being processed in the first place.

Here are the URL encodings I've tried.
hogehoge%40hogepage.com%3Axxxxxxxxxxxxxxxxxxxxxxxxx

I usually only use Python, so I can't read TypeScript and I'm at a loss as to what to do.

[mrubens]

I also thought that I needed to escape symbols, so I tried URL encoding, but it seems that the URL encoding wasn't being processed in the first place.

Here are the URL encodings I've tried. hogehoge%40hogepage.com%3Axxxxxxxxxxxxxxxxxxxxxxxxx

I usually only use Python, so I can't read TypeScript and I'm at a loss as to what to do.

Is there any chance you could get me a key that I can try to repro with?

[potofo]

I created and tested the gateway myself and found out that

This may be because the gateway I'm currently using only uses legacy mode for API-KEY authentication.

I'll review the gateway source code.

# Legacy mode
headers = {
    'api-key': api_key,  # Azure OpenAI resource key
    'Content-Type': 'application/json'
}

or

# Bearer authentification mode
headers = {
    'Authorization': f'Bearer {api_key}',  # Bearer authentification mode
    'Content-Type': 'application/json'
}

[potofo]

Sorry for the wait.

After checking the gateway source code, we found that it does not support Bearer authentication.
This is not a Roo Code issue, so please close it.
Thank you for your support.