コンテンツにスキップ

暗号化セッション

EncryptedSession は任意のセッション実装に透過的な暗号化を提供し、会話データを保護しつつ、古い項目を自動的に期限切れにします。

機能

  • 透過的な暗号化: 任意のセッションを Fernet 暗号化でラップします
  • セッションごとのキー: HKDF 鍵導出によりセッションごとに一意の暗号化を行います
  • 自動失効: TTL が失効した古い項目は静かにスキップされます
  • ドロップイン置換: 既存のあらゆるセッション実装で機能します

インストール

暗号化セッションには encrypt 追加コンポーネントが必要です:

pip install openai-agents[encrypt]

クイックスタート

import asyncio
from agents import Agent, Runner
from agents.extensions.memory import EncryptedSession, SQLAlchemySession

async def main():
    agent = Agent("Assistant")

    # Create underlying session
    underlying_session = SQLAlchemySession.from_url(
        "user-123",
        url="sqlite+aiosqlite:///:memory:",
        create_tables=True
    )

    # Wrap with encryption
    session = EncryptedSession(
        session_id="user-123",
        underlying_session=underlying_session,
        encryption_key="your-secret-key-here",
        ttl=600  # 10 minutes
    )

    result = await Runner.run(agent, "Hello", session=session)
    print(result.final_output)

if __name__ == "__main__":
    asyncio.run(main())

設定

暗号化キー

暗号化キーは Fernet キーでも、任意の文字列でも構いません:

from agents.extensions.memory import EncryptedSession

# Using a Fernet key (base64-encoded)
session = EncryptedSession(
    session_id="user-123",
    underlying_session=underlying_session,
    encryption_key="your-fernet-key-here",
    ttl=600
)

# Using a raw string (will be derived to a key)
session = EncryptedSession(
    session_id="user-123", 
    underlying_session=underlying_session,
    encryption_key="my-secret-password",
    ttl=600
)

TTL (Time To Live)

暗号化された項目の有効期間を設定します:

# Items expire after 1 hour
session = EncryptedSession(
    session_id="user-123",
    underlying_session=underlying_session,
    encryption_key="secret",
    ttl=3600  # 1 hour in seconds
)

# Items expire after 1 day
session = EncryptedSession(
    session_id="user-123",
    underlying_session=underlying_session,
    encryption_key="secret", 
    ttl=86400  # 24 hours in seconds
)

異なるセッション種別での使用

SQLite セッションでの使用

from agents import SQLiteSession
from agents.extensions.memory import EncryptedSession

# Create encrypted SQLite session
underlying = SQLiteSession("user-123", "conversations.db")

session = EncryptedSession(
    session_id="user-123",
    underlying_session=underlying,
    encryption_key="secret-key"
)

SQLAlchemy セッションでの使用

from agents.extensions.memory import EncryptedSession, SQLAlchemySession

# Create encrypted SQLAlchemy session
underlying = SQLAlchemySession.from_url(
    "user-123",
    url="postgresql+asyncpg://user:pass@localhost/db",
    create_tables=True
)

session = EncryptedSession(
    session_id="user-123",
    underlying_session=underlying,
    encryption_key="secret-key"
)

高度なセッション機能

EncryptedSessionAdvancedSQLiteSession のような高度なセッション実装と併用する場合は、次の点に注意してください。

  • メッセージ内容が暗号化されるため、find_turns_by_content() のようなメソッドは効果的に機能しません
  • 内容に基づく検索は暗号化データに対して行われるため、効果が制限されます

鍵導出

EncryptedSession は HKDF ( HMAC-based Key Derivation Function ) を用いて、セッションごとに一意の暗号化キーを導出します。

  • マスターキー: 提供した暗号化キー
  • セッションソルト: セッション ID
  • 情報文字列: "agents.session-store.hkdf.v1"
  • 出力: 32 バイトの Fernet キー

これにより、次が保証されます: - 各セッションに一意の暗号化キーがあること - マスターキーなしでは鍵を導出できないこと - セッションデータは異なるセッション間で復号できないこと

自動失効

項目が TTL を超えた場合、取得時に自動的にスキップされます:

# Items older than TTL are silently ignored
items = await session.get_items()  # Only returns non-expired items

# Expired items don't affect session behavior
result = await Runner.run(agent, "Continue conversation", session=session)

API リファレンス