# cas-sample-python-webapp

**Repository Path**: mirrors_apereo/cas-sample-python-webapp

## Basic Information

- **Project Name**: cas-sample-python-webapp
- **Description**: Sample CASified Python Web Application based on Flask
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-15
- **Last Updated**: 2026-01-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Overview

This is a sample Python web application using Flask that is protected via an Apereo CAS server using the [Flask CAS extension](https://github.com/cameronbwhite/Flask-CAS).

# Requirements

- Python

```console
$ python --version
Python 2.7.10
```

- Pip

```console
$ pip --version
pip 9.0.1 from /Library/Python/2.7/site-packages (python 2.7)
```

# Flask CAS Extension

You *may* need to download/install the CAS Flask extension from source locally to obtain a bug fix that helps with CAS attribute parsing. The bug fix, as of this writing, is not yet released.

```bash
git clone git@github.com:cameronbwhite/Flask-CAS.git
cd Flask-CAS
sudo python setup.py install
```

If you wish to not install the plugin from source, simply execute:

```bash
sudo pip install Flask-CAS
```

# Run

```console
$ python app.py

...

* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: 120-601-740
```

# Test

Navigate to `http://localhost:5000` and click on the login button.
You will be redirected to a CAS server to authenticate and once you return,
you should see the authenticated user id plus any and all attributes that
the server may have authorized you to receive.

![image](https://cloud.githubusercontent.com/assets/1205228/24905959/19cfc362-1ecb-11e7-8ac8-3dcdb82b9303.png)

Remember that the application must be registered with the CAS server, and 
should be authorized to authenticate.

You can find valid username and password under `cas.authn.accept.users` part of [CAS configuration part of CAS server dashboard](https://casserver.herokuapp.com/cas/status/config). It's `casuser`:`Mellon` for version 5.


# Configuration

CAS configuration may be specified in `app.py`:

```python
app.config['CAS_SERVER'] = 'https://jasigcas.herokuapp.com' 
app.config['CAS_AFTER_LOGIN'] = 'secure'
```

For all other relevant settings, please refer to the [Flask CAS extension](https://github.com/cameronbwhite/Flask-CAS) project.