API ํค ์ฒ๋ฆฌ, ์ฟ ํค ๊ธฐ๋ฐ ์ธ์ฆ, ํค๋ ์์ฑ์ ํฌํจํ ์ธ์ฆ ํ๋ก์ธ์ค๋ฅผ ๊ด๋ฆฌํฉ๋๋ค.
์ด ํด๋์ค๋ ๋ค์ํ ์ธ์ฆ ๋ฐฉ๋ฒ์ ์ง์ํฉ๋๋ค:
1. API ํค๋ฅผ ์ง์ ์ฌ์ฉ.
2. ๋ธ๋ผ์ฐ์ ์ฟ ํค๋ฅผ ์ฌ์ฉํ ์ธ์ฆ(ํนํ Google Colab์์).
3. ์ฌ์ฉ์์๊ฒ API ํค๋ฅผ ์
๋ ฅํ๋ผ๋ ๋ฉ์์ง ํ์.
์์ฑ:
์ด๋ฆ |
์ ํ |
์ค๋ช
|
id_token |
str or bool
|
์ ์ ํ์ธ์ ์ฌ์ฉ๋๋ ํ ํฐ์ผ๋ก, ์ด๊ธฐํ ์ False๋ก ์ค์ ๋ฉ๋๋ค.
|
api_key |
str or bool
|
์ธ์ฆ์ฉ API ํค๋ก, ์ด๊ธฐํ ์ False๋ก ์ค์ ๋ฉ๋๋ค.
|
model_key |
bool
|
๋ชจ๋ธ ํค์ ํ๋ ์ด์คํ๋๋ก, ์ด๊ธฐํ ์ False๋ก ์ค์ ๋ฉ๋๋ค.
|
์ ์์ค ์ฝ๋ ultralytics/hub/auth.py
| class Auth:
"""
Manages authentication processes including API key handling, cookie-based authentication, and header generation.
The class supports different methods of authentication:
1. Directly using an API key.
2. Authenticating using browser cookies (specifically in Google Colab).
3. Prompting the user to enter an API key.
Attributes:
id_token (str or bool): Token used for identity verification, initialized as False.
api_key (str or bool): API key for authentication, initialized as False.
model_key (bool): Placeholder for model key, initialized as False.
"""
id_token = api_key = model_key = False
def __init__(self, api_key="", verbose=False):
"""
Initialize the Auth class with an optional API key.
Args:
api_key (str, optional): May be an API key or a combination API key and model ID, i.e. key_id
"""
# Split the input API key in case it contains a combined key_model and keep only the API key part
api_key = api_key.split("_")[0]
# Set API key attribute as value passed or SETTINGS API key if none passed
self.api_key = api_key or SETTINGS.get("api_key", "")
# If an API key is provided
if self.api_key:
# If the provided API key matches the API key in the SETTINGS
if self.api_key == SETTINGS.get("api_key"):
# Log that the user is already logged in
if verbose:
LOGGER.info(f"{PREFIX}Authenticated โ
")
return
else:
# Attempt to authenticate with the provided API key
success = self.authenticate()
# If the API key is not provided and the environment is a Google Colab notebook
elif IS_COLAB:
# Attempt to authenticate using browser cookies
success = self.auth_with_cookies()
else:
# Request an API key
success = self.request_api_key()
# Update SETTINGS with the new API key after successful authentication
if success:
SETTINGS.update({"api_key": self.api_key})
# Log that the new login was successful
if verbose:
LOGGER.info(f"{PREFIX}New authentication successful โ
")
elif verbose:
LOGGER.info(f"{PREFIX}Get API key from {API_KEY_URL} and then run 'yolo hub login API_KEY'")
def request_api_key(self, max_attempts=3):
"""
Prompt the user to input their API key.
Returns the model ID.
"""
import getpass
for attempts in range(max_attempts):
LOGGER.info(f"{PREFIX}Login. Attempt {attempts + 1} of {max_attempts}")
input_key = getpass.getpass(f"Enter API key from {API_KEY_URL} ")
self.api_key = input_key.split("_")[0] # remove model id if present
if self.authenticate():
return True
raise ConnectionError(emojis(f"{PREFIX}Failed to authenticate โ"))
def authenticate(self) -> bool:
"""
Attempt to authenticate with the server using either id_token or API key.
Returns:
(bool): True if authentication is successful, False otherwise.
"""
try:
if header := self.get_auth_header():
r = requests.post(f"{HUB_API_ROOT}/v1/auth", headers=header)
if not r.json().get("success", False):
raise ConnectionError("Unable to authenticate.")
return True
raise ConnectionError("User has not authenticated locally.")
except ConnectionError:
self.id_token = self.api_key = False # reset invalid
LOGGER.warning(f"{PREFIX}Invalid API key โ ๏ธ")
return False
def auth_with_cookies(self) -> bool:
"""
Attempt to fetch authentication via cookies and set id_token. User must be logged in to HUB and running in a
supported browser.
Returns:
(bool): True if authentication is successful, False otherwise.
"""
if not IS_COLAB:
return False # Currently only works with Colab
try:
authn = request_with_credentials(f"{HUB_API_ROOT}/v1/auth/auto")
if authn.get("success", False):
self.id_token = authn.get("data", {}).get("idToken", None)
self.authenticate()
return True
raise ConnectionError("Unable to fetch browser authentication details.")
except ConnectionError:
self.id_token = False # reset invalid
return False
def get_auth_header(self):
"""
Get the authentication header for making API requests.
Returns:
(dict): The authentication header if id_token or API key is set, None otherwise.
"""
if self.id_token:
return {"authorization": f"Bearer {self.id_token}"}
elif self.api_key:
return {"x-api-key": self.api_key}
|
__init__(api_key='', verbose=False)
์ ํ์ API ํค๋ก Auth ํด๋์ค๋ฅผ ์ด๊ธฐํํฉ๋๋ค.
๋งค๊ฐ๋ณ์:
์ด๋ฆ |
์ ํ |
์ค๋ช
|
๊ธฐ๋ณธ๊ฐ |
api_key |
str
|
API ํค ๋๋ API ํค์ ๋ชจ๋ธ ID์ ์กฐํฉ(์: key_id)์ผ ์ ์์ต๋๋ค.
|
''
|
์ ์์ค ์ฝ๋ ultralytics/hub/auth.py
| def __init__(self, api_key="", verbose=False):
"""
Initialize the Auth class with an optional API key.
Args:
api_key (str, optional): May be an API key or a combination API key and model ID, i.e. key_id
"""
# Split the input API key in case it contains a combined key_model and keep only the API key part
api_key = api_key.split("_")[0]
# Set API key attribute as value passed or SETTINGS API key if none passed
self.api_key = api_key or SETTINGS.get("api_key", "")
# If an API key is provided
if self.api_key:
# If the provided API key matches the API key in the SETTINGS
if self.api_key == SETTINGS.get("api_key"):
# Log that the user is already logged in
if verbose:
LOGGER.info(f"{PREFIX}Authenticated โ
")
return
else:
# Attempt to authenticate with the provided API key
success = self.authenticate()
# If the API key is not provided and the environment is a Google Colab notebook
elif IS_COLAB:
# Attempt to authenticate using browser cookies
success = self.auth_with_cookies()
else:
# Request an API key
success = self.request_api_key()
# Update SETTINGS with the new API key after successful authentication
if success:
SETTINGS.update({"api_key": self.api_key})
# Log that the new login was successful
if verbose:
LOGGER.info(f"{PREFIX}New authentication successful โ
")
elif verbose:
LOGGER.info(f"{PREFIX}Get API key from {API_KEY_URL} and then run 'yolo hub login API_KEY'")
|
auth_with_cookies()
์ฟ ํค๋ฅผ ํตํ ์ธ์ฆ ๊ฐ์ ธ์ค๊ธฐ๋ฅผ ์๋ํ๊ณ id_token์ ์ค์ ํฉ๋๋ค. ์ฌ์ฉ์๋ HUB์ ๋ก๊ทธ์ธํ๊ณ ์ง์๋๋ ๋ธ๋ผ์ฐ์ ์์
์ง์๋๋ ๋ธ๋ผ์ฐ์ ์์ ์คํ ์ค์ด์ด์ผ ํฉ๋๋ค.
๋ฐํํฉ๋๋ค:
์ ํ |
์ค๋ช
|
bool
|
์ธ์ฆ์ ์ฑ๊ณตํ๋ฉด ์ฐธ์ด๊ณ , ๊ทธ๋ ์ง ์์ผ๋ฉด ๊ฑฐ์ง์
๋๋ค.
|
์ ์์ค ์ฝ๋ ultralytics/hub/auth.py
| def auth_with_cookies(self) -> bool:
"""
Attempt to fetch authentication via cookies and set id_token. User must be logged in to HUB and running in a
supported browser.
Returns:
(bool): True if authentication is successful, False otherwise.
"""
if not IS_COLAB:
return False # Currently only works with Colab
try:
authn = request_with_credentials(f"{HUB_API_ROOT}/v1/auth/auto")
if authn.get("success", False):
self.id_token = authn.get("data", {}).get("idToken", None)
self.authenticate()
return True
raise ConnectionError("Unable to fetch browser authentication details.")
except ConnectionError:
self.id_token = False # reset invalid
return False
|
authenticate()
id_token ๋๋ API ํค๋ฅผ ์ฌ์ฉํ์ฌ ์๋ฒ์ ์ธ์ฆ์ ์๋ํฉ๋๋ค.
๋ฐํํฉ๋๋ค:
์ ํ |
์ค๋ช
|
bool
|
์ธ์ฆ์ ์ฑ๊ณตํ๋ฉด ์ฐธ์ด๊ณ , ๊ทธ๋ ์ง ์์ผ๋ฉด ๊ฑฐ์ง์
๋๋ค.
|
์ ์์ค ์ฝ๋ ultralytics/hub/auth.py
| def authenticate(self) -> bool:
"""
Attempt to authenticate with the server using either id_token or API key.
Returns:
(bool): True if authentication is successful, False otherwise.
"""
try:
if header := self.get_auth_header():
r = requests.post(f"{HUB_API_ROOT}/v1/auth", headers=header)
if not r.json().get("success", False):
raise ConnectionError("Unable to authenticate.")
return True
raise ConnectionError("User has not authenticated locally.")
except ConnectionError:
self.id_token = self.api_key = False # reset invalid
LOGGER.warning(f"{PREFIX}Invalid API key โ ๏ธ")
return False
|
API ์์ฒญ์ ์ํ ์ธ์ฆ ํค๋๋ฅผ ๊ฐ์ ธ์ต๋๋ค.
๋ฐํํฉ๋๋ค:
์ ํ |
์ค๋ช
|
dict
|
id_token ๋๋ API ํค๊ฐ ์ค์ ๋ ๊ฒฝ์ฐ ์ธ์ฆ ํค๋, ๊ทธ๋ ์ง ์์ผ๋ฉด ์์์
๋๋ค.
|
์ ์์ค ์ฝ๋ ultralytics/hub/auth.py
| def get_auth_header(self):
"""
Get the authentication header for making API requests.
Returns:
(dict): The authentication header if id_token or API key is set, None otherwise.
"""
if self.id_token:
return {"authorization": f"Bearer {self.id_token}"}
elif self.api_key:
return {"x-api-key": self.api_key}
|
request_api_key(max_attempts=3)
์ฌ์ฉ์์๊ฒ API ํค๋ฅผ ์
๋ ฅํ๋ผ๋ ๋ฉ์์ง๋ฅผ ํ์ํฉ๋๋ค.
๋ชจ๋ธ ID๋ฅผ ๋ฐํํฉ๋๋ค.
์ ์์ค ์ฝ๋ ultralytics/hub/auth.py
| def request_api_key(self, max_attempts=3):
"""
Prompt the user to input their API key.
Returns the model ID.
"""
import getpass
for attempts in range(max_attempts):
LOGGER.info(f"{PREFIX}Login. Attempt {attempts + 1} of {max_attempts}")
input_key = getpass.getpass(f"Enter API key from {API_KEY_URL} ")
self.api_key = input_key.split("_")[0] # remove model id if present
if self.authenticate():
return True
raise ConnectionError(emojis(f"{PREFIX}Failed to authenticate โ"))
|