transfer_family.py

from typing import Literal, Optional

from pydantic import BaseModel, Field
from pydantic.networks import IPvAnyAddress


class TransferFamilyAuthorizer(BaseModel):
    username: str = Field(
        description="The username of the user attempting to authenticate.",
        examples=["bobusa", "john.doe", "sftp-user-123", "data-transfer-user"],
    )
    password: Optional[str] = Field(
        default=None,
        description="The password for authentication.",
        examples=["<password>", "<user-password>", None],
    )
    protocol: Literal["SFTP", "FTP", "FTPS"] = Field(
        description="The protocol used for the connection.",
        examples=["SFTP", "FTPS", "FTP"],
    )
    server_id: str = Field(
        ...,
        alias="serverId",
        description="The server ID of the Transfer Family server.",
        examples=["s-abcd123456", "s-1234567890abcdef0", "s-example123"],
    )
    source_ip: IPvAnyAddress = Field(
        ...,
        alias="sourceIp",
        description="The IP address of the client connecting to the Transfer Family server.",
        examples=["192.168.0.100", "10.0.0.50", "127.0.0.1", "203.0.113.12"],
    )