Clearer diagnostic when an API Key SID is passed without `account_sid`
Mantenedores costumam responder em até 1 dia
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 82/100
Direção de pesquisa
Comece por twilio/base/client_base.py, no fallback de account_sid, e revise os testes unitários relacionados em tests/unit. Adicione cobertura para uma API Key SID sem account_sid, verificando também se um account_sid explícito e a configuração de token existente continuam funcionando. O trabalho estará concluído quando o caso de Account SID ausente gerar um erro que indique como proceder e os testes relevantes passarem.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Location (twilio/twilio-python @ default branch 74b9629):
self.account_sid = account_sid or self.username
Problem
The README shows API-key authentication as Client(api_key, api_secret, account_sid). If the third argument is forgotten, e.g. Client("SKxxxx...", "secret"), the constructor accepts it and ClientBase.__init__ falls back to self.account_sid = account_sid or self.username, so the API Key SID is used as the account SID in account-scoped resource paths. The fallback is silent: there is no validation or hint in the constructor, and the mistake only surfaces later as an authentication/not-found error from the API, which does not point at the missing account_sid.
Reproduction
from twilio.rest import Client
client = Client("SK" + "a" * 32, "my-api-secret") # no error
print(client.account_sid) # 'SKaaaa...'
client.messages.create(...) # fails later with an API error
Environment:
- Commit:
74b96296b0805986252b798bda4bca90341487ee(main, twilio 9.12.0) - Toolchain: Python 3.13.18
Workaround: always pass account_sid= explicitly when authenticating with API keys.
Already fixed in twilio/twilio-node
PR: https://github.com/twilio/twilio-node/pull/828 — "fix: give more descriptive error for accountSid init issues" (merged 2022-11-28T17:54:36Z, merge commit e18440d317c). When the SID used as accountSid starts with SK, the constructor error now says that an API Key requires the accountSid to be passed as an additional option. twilio-node already rejects non-AC account SIDs; that check is not being proposed here, only the API Key hint.
How twilio-node fixed it:
--- a/lib/base/BaseTwilio.ts
+++ b/lib/base/BaseTwilio.ts
@@ -88,7 +88,11 @@ export class BaseTwilio {
...
if (!this.accountSid?.startsWith("AC")) {
- throw new Error("accountSid must start with AC");
+ const apiKeyMsg = this.accountSid.startsWith("SK")
+ ? ". The given SID indicates an API Key which requires the accountSid to be passed as an additional option"
+ : "";
+
+ throw new Error("accountSid must start with AC" + apiKeyMsg);
Suggested fix
Mirroring twilio-node's API Key hint, ClientBase.__init__ raises a TwilioException with an actionable message when username starts with SK and neither account_sid nor a credential_provider is given; no AC prefix is enforced and other setups are unchanged:
diff --git a/twilio/base/client_base.py b/twilio/base/client_base.py
--- a/twilio/base/client_base.py
+++ b/twilio/base/client_base.py
@@ -4,6 +4,7 @@ from typing import Dict, List, MutableMapping, Optional, Tuple
from urllib.parse import urlparse, urlunparse
from twilio import __version__
+from twilio.base.exceptions import TwilioException
from twilio.http import HttpClient
from twilio.http.http_client import TwilioHttpClient
from twilio.http.response import Response
@@ -54,6 +55,17 @@ class ClientBase(object):
self.credential_provider = credential_provider or None
""" :type : CredentialProvider """
+ if (
+ not account_sid
+ and not self.credential_provider
+ and self.username
+ and self.username.startswith("SK")
+ ):
+ raise TwilioException(
+ "The given username indicates an API Key SID, which requires "
+ "your Account SID to be passed via account_sid"
+ )
+
self.account_sid = account_sid or self.username
""" :type : str """
self.auth = (self.username, self.password)
Verified on 74b9629 (Python 3.13.18, pytest 9.2.0): a unit test for the reproduction above (Client("SK...", "my-api-secret") must raise an error mentioning the API Key and account_sid, while Client("SK...", secret, account_sid="AC...") and Client("AC...", token) keep working) fails without this patch and passes with it; no other test results change in tests/unit.
I can submit a PR for this.
Checked: #259 / #286 (2016) were about API-key auth not being supported/how to pass the account SID; they predate the current account_sid parameter and don't cover diagnosing the omission.
- Linguagem predominante
- Python
- Estrelas
- 2.1k
- Forks
- 821
- Merge médio
- 9h 33min
- PRs com merge (30d)
- 3
Preparar o ambiente
- Inclui um Dockerfile ou arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de twilio/twilio-python
-
Docs: "Handling Exceptions" should mention that network errors are not `TwilioRestException`Talvez já em andamento @henricop assumiu há 13 dias. Aberta
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 90/100
twilio/twilio-python#986 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
TokenPagination.next_page_async() makes a sync request and fails with an async http clientTalvez já em andamento @sebxt assumiu há 31 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
twilio/twilio-python#976 ·
Mantenedores costumam responder em até 1 dia
-
AsyncTwilioHttpClient does not JSON-serialize request bodies for application/json endpoints (sync client does) → 400 on JSON-body v2 endpointsTalvez já em andamento @Steve0x2a assumiu há 77 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
twilio/twilio-python#932 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
twilio/twilio-python#930 ·
Mantenedores costumam responder em até 1 dia
-
[BUG] AsyncTwilioHttpClient.request does not use self.timeoutTalvez já em andamento @Hashim1999164 assumiu há 96 dias. Abertatype: bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
twilio/twilio-python#925 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de twilio/twilio-python
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
Mantenedores costumam responder em até 1 dia
-
Harden tools/pr_threads.sh: pass all printed thread fields through the deterministic sanitizerAbertaarea:cli area:security enhancement priority:medium size:small
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
RonaldHensbergen/composable-data-stack#1338 ·
Mantenedores costumam responder em até 1 dia
-
area:stdlib effort:S impact:med platform:linux type:bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
Mantenedores costumam responder em até 1 dia
-
automated endpoint-dead needs-curation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
almanac-data/climate-almanac#139 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
UKGovernmentBEIS/inspect_ai#6695 · 1 comentário ·
Mantenedores costumam responder em até 1 dia