ethyca-fides 2.57.1b9__py2.py3-none-any.whl → 2.57.1rc0__py2.py3-none-any.whl

fides/api/alembic/migrations/versions/7c3fbee90c78_add_user_assigned_data_uses_and_system_.py

@@ -1,54 +0,0 @@
-"""add user assigned data_uses and system_id columns to stagedresource
-
-Revision ID: 7c3fbee90c78
-Revises: 9a1eacd2666b
-Create Date: 2025-03-04 15:00:23.874270
-
-"""
-
-import sqlalchemy as sa
-from alembic import op
-from sqlalchemy.dialects import postgresql
-
-# revision identifiers, used by Alembic.
-revision = "7c3fbee90c78"
-down_revision = "9a1eacd2666b"
-branch_labels = None
-depends_on = None
-
-
-def upgrade():
-    # ### commands auto generated by Alembic - please adjust! ###
-    op.add_column(
-        "stagedresource",
-        sa.Column(
-            "user_assigned_system_id", sa.VARCHAR(), autoincrement=False, nullable=True
-        ),
-    )
-    op.add_column(
-        "stagedresource",
-        sa.Column(
-            "user_assigned_data_uses",
-            postgresql.ARRAY(sa.VARCHAR()),
-            server_default=sa.text("'{}'::character varying[]"),
-            autoincrement=False,
-            nullable=False,
-        ),
-    )
-    # ### end Alembic commands ###
-    op.create_index(
-        "ix_stagedresource_user_assigned_system_id",
-        "stagedresource",
-        ["user_assigned_system_id"],
-        unique=False,
-    )
-
-
-def downgrade():
-    # ### commands auto generated by Alembic - please adjust! ###
-    op.drop_column("stagedresource", "user_assigned_data_uses")
-    op.drop_column("stagedresource", "user_assigned_system_id")
-    # ### end Alembic commands ###
-    op.drop_index(
-        "ix_stagedresource_user_assigned_system_id", table_name="stagedresource"
-    )

fides/api/alembic/migrations/versions/9a1eacd2666b_add_description_column_to_asset.py

@@ -1,25 +0,0 @@
-"""add description column to asset
-
-Revision ID: 9a1eacd2666b
-Revises: 69ad6d844e21
-Create Date: 2025-02-28 13:59:26.022822
-
-"""
-
-import sqlalchemy as sa
-from alembic import op
-from sqlalchemy.dialects import postgresql
-
-# revision identifiers, used by Alembic.
-revision = "9a1eacd2666b"
-down_revision = "69ad6d844e21"
-branch_labels = None
-depends_on = None
-
-
-def upgrade():
-    op.add_column("asset", sa.Column("description", sa.String(), nullable=True))
-
-
-def downgrade():
-    op.drop_column("asset", "description")

fides/api/models/privacy_request/__init__.py

@@ -1,44 +0,0 @@
-from .consent import Consent, ConsentRequest
-from .execution_log import (
-    COMPLETED_EXECUTION_LOG_STATUSES,
-    EXITED_EXECUTION_LOG_STATUSES,
-    ExecutionLog,
-    can_run_checkpoint,
-)
-from .privacy_request import (
-    CustomPrivacyRequestField,
-    PrivacyRequest,
-    PrivacyRequestError,
-    PrivacyRequestNotifications,
-)
-from .provided_identity import ProvidedIdentity, ProvidedIdentityType
-from .request_task import RequestTask, TraversalDetails
-from .webhook import (
-    CallbackType,
-    SecondPartyRequestFormat,
-    generate_request_callback_pre_approval_jwe,
-    generate_request_callback_resume_jwe,
-    generate_request_task_callback_jwe,
-)
-
-__all__ = [
-    "CallbackType",
-    "Consent",
-    "ConsentRequest",
-    "COMPLETED_EXECUTION_LOG_STATUSES",
-    "EXITED_EXECUTION_LOG_STATUSES",
-    "CustomPrivacyRequestField",
-    "ExecutionLog",
-    "PrivacyRequest",
-    "PrivacyRequestError",
-    "PrivacyRequestNotifications",
-    "ProvidedIdentity",
-    "ProvidedIdentityType",
-    "RequestTask",
-    "SecondPartyRequestFormat",
-    "TraversalDetails",
-    "can_run_checkpoint",
-    "generate_request_callback_pre_approval_jwe",
-    "generate_request_callback_resume_jwe",
-    "generate_request_task_callback_jwe",
-]

fides/api/models/privacy_request/consent.py

@@ -1,155 +0,0 @@
-# pylint: disable=R0401, C0302
-
-from __future__ import annotations
-
-from datetime import datetime
-from typing import TYPE_CHECKING, Any, Dict, Optional
-
-from loguru import logger
-from sqlalchemy import Boolean, Column, DateTime, ForeignKey, String, UniqueConstraint
-from sqlalchemy.dialects.postgresql import JSONB
-from sqlalchemy.ext.mutable import MutableList
-from sqlalchemy.orm import Session, relationship
-
-from fides.api.db.base_class import Base  # type: ignore[attr-defined]
-from fides.api.db.util import EnumColumn
-from fides.api.models.privacy_request.privacy_request import CustomPrivacyRequestField
-from fides.api.models.privacy_request.provided_identity import ProvidedIdentity
-from fides.api.schemas.privacy_request import PrivacyRequestSource
-from fides.api.schemas.redis_cache import (
-    CustomPrivacyRequestField as CustomPrivacyRequestFieldSchema,
-)
-from fides.api.schemas.redis_cache import IdentityBase
-from fides.api.util.cache import FidesopsRedis, get_cache
-from fides.api.util.identity_verification import IdentityVerificationMixin
-from fides.config import CONFIG
-
-if TYPE_CHECKING:
-    from fides.api.models.privacy_request.privacy_request import (
-        PrivacyRequest,  # type: ignore[attr-defined]
-    )
-
-
-class Consent(Base):
-    """The DB ORM model for Consent."""
-
-    provided_identity_id = Column(
-        String,
-        ForeignKey(ProvidedIdentity.id),
-        nullable=False,
-    )
-    data_use = Column(String, nullable=False)
-    data_use_description = Column(String)
-    opt_in = Column(Boolean, nullable=False)
-    has_gpc_flag = Column(
-        Boolean,
-        server_default="f",
-        default=False,
-        nullable=False,
-    )
-    conflicts_with_gpc = Column(
-        Boolean,
-        server_default="f",
-        default=False,
-        nullable=False,
-    )
-
-    provided_identity = relationship(ProvidedIdentity, back_populates="consent")
-
-    UniqueConstraint(provided_identity_id, data_use, name="uix_identity_data_use")
-
-    identity: Optional[IdentityBase] = None
-
-
-class ConsentRequest(IdentityVerificationMixin, Base):
-    """Tracks consent requests."""
-
-    property_id = Column(
-        String,
-        nullable=True,
-    )
-    provided_identity_id = Column(
-        String, ForeignKey(ProvidedIdentity.id), nullable=False
-    )
-    provided_identity = relationship(
-        ProvidedIdentity,
-        back_populates="consent_request",
-    )
-
-    custom_fields = relationship(
-        "CustomPrivacyRequestField", back_populates="consent_request"
-    )
-
-    preferences = Column(
-        MutableList.as_mutable(JSONB),
-        nullable=True,
-    )
-
-    identity_verified_at = Column(
-        DateTime(timezone=True),
-        nullable=True,
-    )
-
-    source = Column(EnumColumn(PrivacyRequestSource), nullable=True)
-
-    privacy_request_id = Column(String, ForeignKey("privacyrequest.id"), nullable=True)
-    privacy_request = relationship("PrivacyRequest")
-
-    def get_cached_identity_data(self) -> Dict[str, Any]:
-        """Retrieves any identity data pertaining to this request from the cache."""
-        prefix = f"id-{self.id}-identity-*"
-        cache: FidesopsRedis = get_cache()
-        keys = cache.keys(prefix)
-        return {key.split("-")[-1]: cache.get(key) for key in keys}
-
-    def verify_identity(
-        self,
-        db: Session,
-        provided_code: Optional[str] = None,
-    ) -> None:
-        """
-        A method to call the internal identity verification method provided by the
-        `IdentityVerificationMixin`.
-        """
-        self._verify_identity(provided_code=provided_code)
-        self.identity_verified_at = datetime.utcnow()
-        self.save(db)
-
-    def persist_custom_privacy_request_fields(
-        self,
-        db: Session,
-        custom_privacy_request_fields: Optional[
-            Dict[str, CustomPrivacyRequestFieldSchema]
-        ],
-    ) -> None:
-        if not custom_privacy_request_fields:
-            return
-
-        if CONFIG.execution.allow_custom_privacy_request_field_collection:
-            for key, item in custom_privacy_request_fields.items():
-                if item.value:
-                    hashed_value = CustomPrivacyRequestField.hash_value(item.value)
-                    CustomPrivacyRequestField.create(
-                        db=db,
-                        data={
-                            "consent_request_id": self.id,
-                            "field_name": key,
-                            "field_label": item.label,
-                            "encrypted_value": {"value": item.value},
-                            "hashed_value": hashed_value,
-                        },
-                    )
-        else:
-            logger.info(
-                "Custom fields provided in consent request {}, but config setting 'CONFIG.execution.allow_custom_privacy_request_field_collection' prevents their storage.",
-                self.id,
-            )
-
-    def get_persisted_custom_privacy_request_fields(self) -> Dict[str, Any]:
-        return {
-            field.field_name: {
-                "label": field.field_label,
-                "value": field.encrypted_value["value"],
-            }
-            for field in self.custom_fields  # type: ignore[attr-defined]
-        }

fides/api/models/privacy_request/execution_log.py

@@ -1,108 +0,0 @@
-# pylint: disable=R0401, C0302
-
-from __future__ import annotations
-
-from typing import Optional
-
-from sqlalchemy import Column, DateTime, String
-from sqlalchemy.dialects.postgresql import JSONB
-from sqlalchemy.ext.mutable import MutableList
-from sqlalchemy.sql import text
-
-from fides.api.db.base_class import Base  # type: ignore[attr-defined]
-from fides.api.db.util import EnumColumn
-from fides.api.schemas.policy import ActionType, CurrentStep
-from fides.api.schemas.privacy_request import ExecutionLogStatus
-
-# Locations from which privacy request execution can be resumed, in order.
-EXECUTION_CHECKPOINTS = [
-    CurrentStep.pre_webhooks,
-    CurrentStep.access,
-    CurrentStep.upload_access,
-    CurrentStep.erasure,
-    CurrentStep.finalize_erasure,
-    CurrentStep.consent,
-    CurrentStep.finalize_consent,
-    CurrentStep.email_post_send,
-    CurrentStep.post_webhooks,
-]
-
-COMPLETED_EXECUTION_LOG_STATUSES = [
-    ExecutionLogStatus.complete,
-    ExecutionLogStatus.skipped,
-]
-
-EXITED_EXECUTION_LOG_STATUSES = [
-    ExecutionLogStatus.complete,
-    ExecutionLogStatus.error,
-    ExecutionLogStatus.skipped,
-]
-
-
-def can_run_checkpoint(
-    request_checkpoint: CurrentStep, from_checkpoint: Optional[CurrentStep] = None
-) -> bool:
-    """Determine whether we should run a specific checkpoint in privacy request execution
-
-    If there's no from_checkpoint specified we should always run the current checkpoint.
-    """
-    if not from_checkpoint:
-        return True
-    return EXECUTION_CHECKPOINTS.index(
-        request_checkpoint
-    ) >= EXECUTION_CHECKPOINTS.index(from_checkpoint)
-
-
-class ExecutionLog(Base):
-    """
-    Stores the individual execution logs associated with a PrivacyRequest.
-
-    Execution logs contain information about the individual queries as they progress through the workflow
-    generated by the query builder.
-    """
-
-    connection_key = Column(String, index=True)
-    # Name of the fides-annotated dataset, for example: my-mongo-db
-    dataset_name = Column(String, index=True)
-    # Name of the particular collection or table affected
-    collection_name = Column(String, index=True)
-    # A JSON Array describing affected fields along with their data categories and paths
-    fields_affected = Column(MutableList.as_mutable(JSONB), nullable=True)
-    # Contains info, warning, or error messages
-    message = Column(String)
-    action_type = Column(
-        EnumColumn(ActionType),
-        index=True,
-        nullable=False,
-    )
-    status = Column(
-        EnumColumn(
-            ExecutionLogStatus,
-            native_enum=True,
-            values_callable=lambda x: [
-                i.value for i in x
-            ],  # Using ExecutionLogStatus values in database, even though app is using the names.
-        ),
-        index=True,
-        nullable=False,
-    )
-
-    privacy_request_id = Column(
-        String,
-        nullable=False,
-        index=True,
-    )
-
-    # Use clock_timestamp() instead of NOW() to get the actual current time at row creation,
-    # regardless of transaction state. This prevents timestamp caching within transactions
-    # and ensures more accurate creation times.
-    # https://www.postgresql.org/docs/current/functions-datetime.html#FUNCTIONS-DATETIME-CURRENT
-
-    created_at = Column(
-        DateTime(timezone=True), server_default=text("clock_timestamp()")
-    )
-    updated_at = Column(
-        DateTime(timezone=True),
-        server_default=text("clock_timestamp()"),
-        onupdate=text("clock_timestamp()"),
-    )

fides/api/models/privacy_request/provided_identity.py

@@ -1,149 +0,0 @@
-# pylint: disable=R0401, C0302
-
-from __future__ import annotations
-
-from enum import Enum as EnumType
-from typing import TYPE_CHECKING
-
-from sqlalchemy import Column, ForeignKey, String
-from sqlalchemy.ext.mutable import MutableDict
-from sqlalchemy.orm import relationship
-from sqlalchemy_utils.types.encrypted.encrypted_type import (
-    AesGcmEngine,
-    StringEncryptedType,
-)
-
-from fides.api.cryptography.cryptographic_util import (
-    hash_credential_with_salt,
-    hash_value_with_salt,
-)
-from fides.api.cryptography.identity_salt import get_identity_salt
-from fides.api.db.base_class import Base  # type: ignore[attr-defined]
-from fides.api.db.base_class import JSONTypeOverride
-from fides.api.migrations.hash_migration_mixin import HashMigrationMixin
-from fides.api.schemas.redis_cache import Identity, LabeledIdentity, MultiValue
-from fides.config import CONFIG
-
-if TYPE_CHECKING:
-    from fides.api.models.privacy_request.consent import Consent, ConsentRequest
-    from fides.api.models.privacy_request.privacy_request import PrivacyRequest
-
-
-class ProvidedIdentityType(EnumType):
-    """Enum for privacy request identity types"""
-
-    email = "email"
-    phone_number = "phone_number"
-    ga_client_id = "ga_client_id"
-    ljt_readerID = "ljt_readerID"
-    fides_user_device_id = "fides_user_device_id"
-    external_id = "external_id"
-
-
-class ProvidedIdentity(HashMigrationMixin, Base):  # pylint: disable=R0904
-    """
-    A table for storing identity fields and values provided at privacy request
-    creation time.
-    """
-
-    privacy_request_id = Column(
-        String,
-        ForeignKey("privacyrequest.id", ondelete="CASCADE", onupdate="CASCADE"),
-    )
-    privacy_request = relationship(
-        "PrivacyRequest",
-        backref="provided_identities",
-    )  # Which privacy request this identity belongs to
-
-    field_name = Column(
-        String,
-        index=False,
-        nullable=False,
-    )
-    field_label = Column(
-        String,
-        index=False,
-        nullable=True,
-    )
-    hashed_value = Column(
-        String,
-        index=True,
-        unique=False,
-        nullable=True,
-    )  # This field is used as a blind index for exact match searches
-    encrypted_value = Column(
-        MutableDict.as_mutable(
-            StringEncryptedType(
-                JSONTypeOverride,
-                CONFIG.security.app_encryption_key,
-                AesGcmEngine,
-                "pkcs5",
-            )
-        ),
-        nullable=True,
-    )  # Type bytea in the db
-    consent = relationship(
-        "Consent", back_populates="provided_identity", cascade="delete, delete-orphan"
-    )
-    consent_request = relationship(
-        "ConsentRequest",
-        back_populates="provided_identity",
-        cascade="delete, delete-orphan",
-    )
-
-    @classmethod
-    def bcrypt_hash_value(
-        cls,
-        value: MultiValue,
-        encoding: str = "UTF-8",
-    ) -> str:
-        """
-        Temporary function used to hash values to the previously used bcrypt hashes.
-        This can be removed once the bcrypt to SHA-256 migration is complete.
-        """
-
-        SALT = "$2b$12$UErimNtlsE6qgYf2BrI1Du"
-        value_str = str(value)
-        hashed_value = hash_credential_with_salt(
-            value_str.encode(encoding),
-            SALT.encode(encoding),
-        )
-        return hashed_value
-
-    @classmethod
-    def hash_value(
-        cls,
-        value: MultiValue,
-        encoding: str = "UTF-8",
-    ) -> str:
-        """Utility function to hash the value with a generated salt"""
-        SALT = get_identity_salt()
-        value_str = str(value)
-        hashed_value = hash_value_with_salt(
-            value_str.encode(encoding),
-            SALT.encode(encoding),
-        )
-        return hashed_value
-
-    def migrate_hashed_fields(self) -> None:
-        if value := self.encrypted_value.get("value"):
-            self.hashed_value = self.hash_value(value)
-        self.is_hash_migrated = True
-
-    def as_identity_schema(self) -> Identity:
-        """Creates an Identity schema from a ProvidedIdentity record in the application DB."""
-
-        identity_dict = {}
-        if any(
-            [
-                not self.field_name,
-                not self.encrypted_value,
-            ]
-        ):
-            return Identity()
-
-        value = self.encrypted_value.get("value")  # type:ignore
-        if self.field_label:
-            value = LabeledIdentity(label=self.field_label, value=value)
-        identity_dict[self.field_name] = value
-        return Identity(**identity_dict)