bt-cli 0.4.13__py3-none-any.whl

bt_cli/pws/models/account.py

@@ -0,0 +1,186 @@
+"""Managed Account models for Password Safe API."""
+
+from typing import Any, Optional
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ManagedAccount(BaseModel):
+    """Managed account in Password Safe."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    managed_account_id: int = Field(alias="ManagedAccountID")
+    managed_system_id: int = Field(alias="ManagedSystemID")
+    account_name: str = Field(alias="AccountName")
+    domain_name: Optional[str] = Field(default=None, alias="DomainName")
+    description: Optional[str] = Field(default=None, alias="Description")
+
+    # System info (populated in some responses)
+    system_name: Optional[str] = Field(default=None, alias="SystemName")
+    platform_id: Optional[int] = Field(default=None, alias="PlatformID")
+
+    # API access
+    api_enabled: Optional[bool] = Field(default=None, alias="ApiEnabled")
+
+    # Password management flags
+    auto_management_flag: Optional[bool] = Field(default=None, alias="AutoManagementFlag")
+    check_password_flag: Optional[bool] = Field(default=None, alias="CheckPasswordFlag")
+    change_password_after_any_release_flag: Optional[bool] = Field(
+        default=None, alias="ChangePasswordAfterAnyReleaseFlag"
+    )
+    reset_password_on_mismatch_flag: Optional[bool] = Field(
+        default=None, alias="ResetPasswordOnMismatchFlag"
+    )
+
+    # Password change schedule
+    change_frequency_type: Optional[str] = Field(default=None, alias="ChangeFrequencyType")
+    change_frequency_days: Optional[int] = Field(default=None, alias="ChangeFrequencyDays")
+    change_time: Optional[str] = Field(default=None, alias="ChangeTime")
+    next_change_date: Optional[datetime] = Field(default=None, alias="NextChangeDate")
+    last_change_date: Optional[datetime] = Field(default=None, alias="LastChangeDate")
+
+    # Password rules
+    password_rule_id: Optional[int] = Field(default=None, alias="PasswordRuleID")
+    dss_key_rule_id: Optional[int] = Field(default=None, alias="DSSKeyRuleID")
+
+    # Status
+    status: Optional[str] = Field(default=None, alias="Status")
+    is_subscribed_account: Optional[bool] = Field(default=None, alias="IsSubscribedAccount")
+    created_date: Optional[datetime] = Field(default=None, alias="CreatedDate")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "ManagedAccount":
+        """Create ManagedAccount from API response."""
+        return cls.model_validate(data)
+
+    @property
+    def display_name(self) -> str:
+        """Get a display name for the account."""
+        if self.domain_name:
+            return f"{self.domain_name}\\{self.account_name}"
+        return self.account_name
+
+    @property
+    def full_path(self) -> str:
+        """Get the full path (system/account)."""
+        if self.system_name:
+            return f"{self.system_name}/{self.account_name}"
+        return f"System-{self.managed_system_id}/{self.account_name}"
+
+    @property
+    def id(self) -> int:
+        """Alias for managed_account_id for convenience."""
+        return self.managed_account_id
+
+
+class ManagedAccountCreate(BaseModel):
+    """Data for creating a managed account."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    account_name: str = Field(alias="AccountName")
+    password: Optional[str] = Field(default=None, alias="Password")
+    domain_name: Optional[str] = Field(default=None, alias="DomainName")
+    description: Optional[str] = Field(default=None, alias="Description")
+    api_enabled: bool = Field(default=True, alias="ApiEnabled")
+    auto_management_flag: bool = Field(default=True, alias="AutoManagementFlag")
+    check_password_flag: bool = Field(default=True, alias="CheckPasswordFlag")
+    change_password_after_any_release_flag: bool = Field(
+        default=False, alias="ChangePasswordAfterAnyReleaseFlag"
+    )
+    reset_password_on_mismatch_flag: bool = Field(
+        default=False, alias="ResetPasswordOnMismatchFlag"
+    )
+    change_frequency_type: Optional[str] = Field(default=None, alias="ChangeFrequencyType")
+    change_frequency_days: Optional[int] = Field(default=None, alias="ChangeFrequencyDays")
+    change_time: Optional[str] = Field(default=None, alias="ChangeTime")
+    next_change_date: Optional[str] = Field(default=None, alias="NextChangeDate")
+    password_rule_id: Optional[int] = Field(default=None, alias="PasswordRuleID")
+    dss_key_rule_id: Optional[int] = Field(default=None, alias="DSSKeyRuleID")
+
+    def to_api_dict(self) -> dict[str, Any]:
+        """Convert to API-compatible dictionary."""
+        return self.model_dump(by_alias=True, exclude_none=True)
+
+
+class ManagedAccountUpdate(BaseModel):
+    """Data for updating a managed account."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    account_name: Optional[str] = Field(default=None, alias="AccountName")
+    domain_name: Optional[str] = Field(default=None, alias="DomainName")
+    description: Optional[str] = Field(default=None, alias="Description")
+    api_enabled: Optional[bool] = Field(default=None, alias="ApiEnabled")
+    auto_management_flag: Optional[bool] = Field(default=None, alias="AutoManagementFlag")
+    check_password_flag: Optional[bool] = Field(default=None, alias="CheckPasswordFlag")
+    change_password_after_any_release_flag: Optional[bool] = Field(
+        default=None, alias="ChangePasswordAfterAnyReleaseFlag"
+    )
+    reset_password_on_mismatch_flag: Optional[bool] = Field(
+        default=None, alias="ResetPasswordOnMismatchFlag"
+    )
+    change_frequency_type: Optional[str] = Field(default=None, alias="ChangeFrequencyType")
+    change_frequency_days: Optional[int] = Field(default=None, alias="ChangeFrequencyDays")
+    change_time: Optional[str] = Field(default=None, alias="ChangeTime")
+    password_rule_id: Optional[int] = Field(default=None, alias="PasswordRuleID")
+    dss_key_rule_id: Optional[int] = Field(default=None, alias="DSSKeyRuleID")
+
+    def to_api_dict(self) -> dict[str, Any]:
+        """Convert to API-compatible dictionary."""
+        return self.model_dump(by_alias=True, exclude_none=True)
+
+
+class FunctionalAccount(BaseModel):
+    """Functional account used for system management operations."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    functional_account_id: int = Field(alias="FunctionalAccountID")
+    account_name: str = Field(alias="AccountName")
+    domain_name: Optional[str] = Field(default=None, alias="DomainName")
+    platform_id: Optional[int] = Field(default=None, alias="PlatformID")
+    description: Optional[str] = Field(default=None, alias="Description")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "FunctionalAccount":
+        """Create FunctionalAccount from API response."""
+        return cls.model_validate(data)
+
+
+class PasswordRule(BaseModel):
+    """Password complexity rule."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    password_rule_id: int = Field(alias="PasswordRuleID")
+    name: str = Field(alias="Name")
+    description: Optional[str] = Field(default=None, alias="Description")
+    min_length: Optional[int] = Field(default=None, alias="MinLength")
+    max_length: Optional[int] = Field(default=None, alias="MaxLength")
+    require_upper: Optional[bool] = Field(default=None, alias="RequireUpper")
+    require_lower: Optional[bool] = Field(default=None, alias="RequireLower")
+    require_numeric: Optional[bool] = Field(default=None, alias="RequireNumeric")
+    require_special: Optional[bool] = Field(default=None, alias="RequireSpecial")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "PasswordRule":
+        """Create PasswordRule from API response."""
+        return cls.model_validate(data)
+
+
+class Application(BaseModel):
+    """Application that can be assigned to accounts."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    application_id: int = Field(alias="ApplicationID")
+    name: str = Field(alias="Name")
+    description: Optional[str] = Field(default=None, alias="Description")
+    version: Optional[str] = Field(default=None, alias="Version")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "Application":
+        """Create Application from API response."""
+        return cls.model_validate(data)

bt_cli/pws/models/asset.py

@@ -0,0 +1,102 @@
+"""Asset models for BeyondInsight API."""
+
+from typing import Any, Optional
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class Asset(BaseModel):
+    """Asset (discovered or manually created system)."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    asset_id: int = Field(alias="AssetID")
+    asset_name: Optional[str] = Field(default=None, alias="AssetName")
+    ip_address: Optional[str] = Field(default=None, alias="IPAddress")
+    dns_name: Optional[str] = Field(default=None, alias="DnsName")
+    domain_name: Optional[str] = Field(default=None, alias="DomainName")
+    mac_address: Optional[str] = Field(default=None, alias="MACAddress")
+    asset_type: Optional[str] = Field(default=None, alias="AssetType")
+    workgroup_id: Optional[int] = Field(default=None, alias="WorkgroupID")
+    workgroup_name: Optional[str] = Field(default=None, alias="WorkgroupName")
+    operating_system: Optional[str] = Field(default=None, alias="OperatingSystem")
+    created_date: Optional[datetime] = Field(default=None, alias="CreatedDate")
+    last_updated_date: Optional[datetime] = Field(default=None, alias="LastUpdatedDate")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "Asset":
+        """Create Asset from API response."""
+        return cls.model_validate(data)
+
+    @property
+    def display_name(self) -> str:
+        """Get a display name for the asset."""
+        return self.asset_name or self.dns_name or self.ip_address or f"Asset-{self.asset_id}"
+
+
+class Workgroup(BaseModel):
+    """Workgroup for organizing assets and systems."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    workgroup_id: int = Field(alias="WorkgroupID")
+    name: str = Field(alias="Name")
+    description: Optional[str] = Field(default=None, alias="Description")
+    created_date: Optional[datetime] = Field(default=None, alias="CreatedDate")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "Workgroup":
+        """Create Workgroup from API response."""
+        return cls.model_validate(data)
+
+
+class Platform(BaseModel):
+    """Platform (OS type) for managed systems."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    platform_id: int = Field(alias="PlatformID")
+    name: str = Field(alias="Name")
+    short_name: Optional[str] = Field(default=None, alias="ShortName")
+    platform_type: Optional[str] = Field(default=None, alias="PlatformType")
+    port_number: Optional[int] = Field(default=None, alias="PortNumber")
+    supports_sessions: Optional[bool] = Field(default=None, alias="SupportsSessions")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "Platform":
+        """Create Platform from API response."""
+        return cls.model_validate(data)
+
+
+class SmartRule(BaseModel):
+    """Smart rule for automated system/account management."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    smart_rule_id: int = Field(alias="SmartRuleID")
+    name: str = Field(alias="Name")
+    description: Optional[str] = Field(default=None, alias="Description")
+    category: Optional[str] = Field(default=None, alias="Category")
+    status: Optional[str] = Field(default=None, alias="Status")
+    created_date: Optional[datetime] = Field(default=None, alias="CreatedDate")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "SmartRule":
+        """Create SmartRule from API response."""
+        return cls.model_validate(data)
+
+
+class Attribute(BaseModel):
+    """Custom attribute for assets, systems, or accounts."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    attribute_id: int = Field(alias="AttributeID")
+    name: str = Field(alias="Name")
+    attribute_type: Optional[str] = Field(default=None, alias="AttributeType")
+    description: Optional[str] = Field(default=None, alias="Description")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "Attribute":
+        """Create Attribute from API response."""
+        return cls.model_validate(data)

bt_cli/pws/models/common.py

@@ -0,0 +1,132 @@
+"""Common models and types shared across the API."""
+
+from typing import Any, Generic, Optional, TypeVar
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict
+
+
+# Type variable for generic paginated responses
+T = TypeVar("T", bound=BaseModel)
+
+
+class BaseAPIModel(BaseModel):
+    """Base model for all API responses.
+
+    Allows extra fields to handle API changes gracefully.
+    """
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "BaseAPIModel":
+        """Create model instance from API response data.
+
+        Args:
+            data: Dictionary from API response
+
+        Returns:
+            Model instance
+        """
+        return cls.model_validate(data)
+
+
+class EntityRef(BaseModel):
+    """Reference to an entity by ID and optional name."""
+
+    model_config = ConfigDict(extra="allow")
+
+    id: int
+    name: Optional[str] = None
+
+
+class PaginatedResponse(BaseModel, Generic[T]):
+    """Generic paginated response wrapper."""
+
+    model_config = ConfigDict(extra="allow")
+
+    data: list[T]
+    total: Optional[int] = None
+    offset: Optional[int] = None
+    limit: Optional[int] = None
+
+
+class ApiError(BaseModel):
+    """API error response."""
+
+    model_config = ConfigDict(extra="allow")
+
+    message: Optional[str] = None
+    error: Optional[str] = None
+    status_code: Optional[int] = None
+    details: Optional[dict[str, Any]] = None
+
+
+class Timestamp(BaseModel):
+    """Timestamp wrapper for API datetime fields."""
+
+    model_config = ConfigDict(extra="allow")
+
+    value: Optional[datetime] = None
+
+    @classmethod
+    def from_api_string(cls, value: Optional[str]) -> "Timestamp":
+        """Parse timestamp from API string format.
+
+        Args:
+            value: ISO format datetime string or None
+
+        Returns:
+            Timestamp instance
+        """
+        if not value:
+            return cls(value=None)
+        try:
+            # Handle various datetime formats
+            return cls(value=datetime.fromisoformat(value.replace("Z", "+00:00")))
+        except (ValueError, AttributeError):
+            return cls(value=None)
+
+
+# Common field aliases for API responses
+COMMON_FIELD_ALIASES = {
+    "id": ["Id", "ID"],
+    "name": ["Name", "SystemName", "AccountName"],
+    "description": ["Description", "Desc"],
+    "created_at": ["CreatedDate", "DateCreated", "CreateDate"],
+    "updated_at": ["UpdatedDate", "DateUpdated", "ModifiedDate", "LastModifiedDate"],
+}
+
+
+def normalize_api_response(data: dict[str, Any]) -> dict[str, Any]:
+    """Normalize API response field names to lowercase with underscores.
+
+    Args:
+        data: API response dictionary
+
+    Returns:
+        Normalized dictionary with consistent field names
+    """
+    if not data:
+        return data
+
+    result = {}
+    for key, value in data.items():
+        # Convert PascalCase to snake_case
+        normalized_key = ""
+        for i, char in enumerate(key):
+            if char.isupper() and i > 0:
+                normalized_key += "_"
+            normalized_key += char.lower()
+
+        # Recursively normalize nested objects
+        if isinstance(value, dict):
+            value = normalize_api_response(value)
+        elif isinstance(value, list):
+            value = [
+                normalize_api_response(item) if isinstance(item, dict) else item
+                for item in value
+            ]
+
+        result[normalized_key] = value
+
+    return result

bt_cli/pws/models/system.py

@@ -0,0 +1,121 @@
+"""Managed System models for Password Safe API."""
+
+from typing import Any, Optional
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ManagedSystem(BaseModel):
+    """Managed system in Password Safe."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    managed_system_id: int = Field(alias="ManagedSystemID")
+    system_name: str = Field(alias="SystemName")
+    platform_id: Optional[int] = Field(default=None, alias="PlatformID")
+    platform_name: Optional[str] = Field(default=None, alias="PlatformName")
+    workgroup_id: Optional[int] = Field(default=None, alias="WorkgroupID")
+    workgroup_name: Optional[str] = Field(default=None, alias="WorkgroupName")
+    asset_id: Optional[int] = Field(default=None, alias="AssetID")
+    contact_email: Optional[str] = Field(default=None, alias="ContactEmail")
+    description: Optional[str] = Field(default=None, alias="Description")
+    port: Optional[int] = Field(default=None, alias="Port")
+    timeout: Optional[int] = Field(default=None, alias="Timeout")
+
+    # Functional account for management operations
+    functional_account_id: Optional[int] = Field(default=None, alias="FunctionalAccountID")
+    functional_account_name: Optional[str] = Field(default=None, alias="FunctionalAccountName")
+
+    # Elevation settings
+    elevation_command: Optional[str] = Field(default=None, alias="ElevationCommand")
+
+    # Password management settings
+    check_password_flag: Optional[bool] = Field(default=None, alias="CheckPasswordFlag")
+    change_password_after_any_release_flag: Optional[bool] = Field(
+        default=None, alias="ChangePasswordAfterAnyReleaseFlag"
+    )
+    reset_password_on_mismatch_flag: Optional[bool] = Field(
+        default=None, alias="ResetPasswordOnMismatchFlag"
+    )
+    change_frequency_type: Optional[str] = Field(default=None, alias="ChangeFrequencyType")
+    change_frequency_days: Optional[int] = Field(default=None, alias="ChangeFrequencyDays")
+    change_time: Optional[str] = Field(default=None, alias="ChangeTime")
+
+    # Status and metadata
+    is_reachable: Optional[bool] = Field(default=None, alias="IsReachable")
+    last_change_date: Optional[datetime] = Field(default=None, alias="LastChangeDate")
+    created_date: Optional[datetime] = Field(default=None, alias="CreatedDate")
+
+    @classmethod
+    def from_api(cls, data: dict[str, Any]) -> "ManagedSystem":
+        """Create ManagedSystem from API response."""
+        return cls.model_validate(data)
+
+    @property
+    def display_name(self) -> str:
+        """Get a display name for the system."""
+        return self.system_name
+
+    @property
+    def id(self) -> int:
+        """Alias for managed_system_id for convenience."""
+        return self.managed_system_id
+
+
+class ManagedSystemCreate(BaseModel):
+    """Data for creating a managed system."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    system_name: str = Field(alias="SystemName")
+    platform_id: int = Field(alias="PlatformID")
+    workgroup_id: Optional[int] = Field(default=None, alias="WorkgroupID")
+    asset_id: Optional[int] = Field(default=None, alias="AssetID")
+    contact_email: Optional[str] = Field(default=None, alias="ContactEmail")
+    description: Optional[str] = Field(default=None, alias="Description")
+    port: Optional[int] = Field(default=None, alias="Port")
+    timeout: Optional[int] = Field(default=None, alias="Timeout")
+    functional_account_id: Optional[int] = Field(default=None, alias="FunctionalAccountID")
+    elevation_command: Optional[str] = Field(default=None, alias="ElevationCommand")
+    check_password_flag: Optional[bool] = Field(default=None, alias="CheckPasswordFlag")
+    change_password_after_any_release_flag: Optional[bool] = Field(
+        default=None, alias="ChangePasswordAfterAnyReleaseFlag"
+    )
+    reset_password_on_mismatch_flag: Optional[bool] = Field(
+        default=None, alias="ResetPasswordOnMismatchFlag"
+    )
+    change_frequency_type: Optional[str] = Field(default=None, alias="ChangeFrequencyType")
+    change_frequency_days: Optional[int] = Field(default=None, alias="ChangeFrequencyDays")
+    change_time: Optional[str] = Field(default=None, alias="ChangeTime")
+
+    def to_api_dict(self) -> dict[str, Any]:
+        """Convert to API-compatible dictionary."""
+        return self.model_dump(by_alias=True, exclude_none=True)
+
+
+class ManagedSystemUpdate(BaseModel):
+    """Data for updating a managed system."""
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    system_name: Optional[str] = Field(default=None, alias="SystemName")
+    contact_email: Optional[str] = Field(default=None, alias="ContactEmail")
+    description: Optional[str] = Field(default=None, alias="Description")
+    port: Optional[int] = Field(default=None, alias="Port")
+    timeout: Optional[int] = Field(default=None, alias="Timeout")
+    functional_account_id: Optional[int] = Field(default=None, alias="FunctionalAccountID")
+    elevation_command: Optional[str] = Field(default=None, alias="ElevationCommand")
+    check_password_flag: Optional[bool] = Field(default=None, alias="CheckPasswordFlag")
+    change_password_after_any_release_flag: Optional[bool] = Field(
+        default=None, alias="ChangePasswordAfterAnyReleaseFlag"
+    )
+    reset_password_on_mismatch_flag: Optional[bool] = Field(
+        default=None, alias="ResetPasswordOnMismatchFlag"
+    )
+    change_frequency_type: Optional[str] = Field(default=None, alias="ChangeFrequencyType")
+    change_frequency_days: Optional[int] = Field(default=None, alias="ChangeFrequencyDays")
+    change_time: Optional[str] = Field(default=None, alias="ChangeTime")
+
+    def to_api_dict(self) -> dict[str, Any]:
+        """Convert to API-compatible dictionary."""
+        return self.model_dump(by_alias=True, exclude_none=True)