enterprise/enterprise_hooks/secrets_plugins/huggingface.py

"""
This plugin searches for Hugging Face Access and Organization API Tokens.
"""

import re

from detect_secrets.plugins.base import RegexBasedDetector


class HuggingFaceDetector(RegexBasedDetector):
    """Scans for Hugging Face Tokens."""

    @property
    def secret_type(self) -> str:
        return "Hugging Face Token"

    @property
    def denylist(self) -> list[re.Pattern]:
        return [
            # Hugging Face Access token
            re.compile(r"""(?:^|[\\'"` >=:])(hf_[a-zA-Z]{34})(?:$|[\\'"` <])"""),
            # Hugging Face Organization API token
            re.compile(
                r"""(?:^|[\\'"` >=:\(,)])(api_org_[a-zA-Z]{34})(?:$|[\\'"` <\),])"""
            ),
        ]