pycas-sso 0.1.0

Python client for the CAS protocol, compatible with several HTTP clients with asynchronous support.

PyCAS-SSO

PyCAS-SSO is a Python client for the CAS protocol (Central Authentication Service), compatible with multiple HTTP clients with asynchronous support.

🎯 Features

• Client for CAS Protocol : Implementation of the CAS protocol (1.0, 2.0 and 3.0).
• Ticket validation : Support Ticket validation using CAS protocol.
• User Attributes : Extract user attribute from CAS response.
• Multi-HTTP Clients : Support for requests, httpx, and aiohttp.
• Async/Await : Optional support for asynchronous programming.

Disclaimer: This library is in early version. Bugs may still exist, particularly in advanced CAS features and structure might be subject to change. Use it at your own risk.

📦 Installation

Requirements

• Python 3.10+

Basic Installation

pip install pycas-sso[httpx]

Installation with alternative HTTP library

# With requests library
pip install pycas-sso[requests]

# With aiohttp library
pip install pycas-sso[aiohttp]

🔧 Supported HTTP Clients

Client	Synchronous	Asynchronous	Installation
requests	✅	❌	pip install pycas-sso[requests]
httpx	✅	✅	pip install pycas-sso[httpx]
aiohttp	❌	✅	pip install pycas-sso[aiohttp]

The library will automatically detect the available client if you don't specify one.

🚀 Quick Start

Basic Usage (Synchronous)

from pycas_sso import CASClient

# Create a CAS client
with CASClient.create(
    'https://cas.example.com',
    'https://myapp.example.com',
    'https://myapp.example.com/login',
    http_lib='requests'
) as client:

    # Validate a CAS ticket
    try:
        user_info = client.service_validate('ST-123456-abcdef')
        print(f"Authenticated user: {user_info}")
    except Exception as e:
        print(f"Validation error: {e}")

Asynchronous Usage

import asyncio
from pycas_sso import CASClient

async def main():
    # Create an asynchronous CAS client
    async with CASClient.create(
        'https://cas.example.com',
        'https://myapp.example.com',
        'https://myapp.example.com/login',
        http_lib='httpx'  # or 'aiohttp'
    ) as client:
    
        # Validate a ticket asynchronously
        try:
            user_info = await client.aservice_validate('ST-123456-abcdef')
            print(f"Authenticated user: {user_info}")
        except Exception as e:
            print(f"Validation error: {e}")

# Run
asyncio.run(main())

📚 Documentation

Full documentation is available at https://pycas-sso.readthedocs.io/.

Contributing

If you want to contribute to the documentation, clone the repo. Then install required packages from docs/requirements.txt.

pip install -r docs/requirements.txt

🧪 Testing & Development

First install packages required for testing:

pip install pycas-sso[dev]

Then run the test suite with coverage:

pytest -vv

📝 License

This project is licensed under BSD-3-Clause or later. See LICENSE for more details.

👤 Author

• C. Nicolas - GitHub

🤝 Contributing

Contributions are welcome! Please refer to CONTRIBUTING.md for guidelines.

📋 Changelog

See CHANGELOG.md for the history of changes.

📖 Resources

• CAS Protocol Documentation
• Apereo CAS

---

Note : This library implements the CAS protocol (Central Authentication Service) and is compatible with Apereo CAS servers and other compatible implementations.