Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Introductory Docs #2

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
cromlech.sessions.jwt
======


This packaged provides HTTP server side sessions using JWT and Cookies.

JWT is way of encrypting a json file, so that it can be used for secure communications.

cromlech.sessions.jwt uses that encrypted information to keep a person logged in, even though HTTP is a stateless protocol.

In the old days, we used a session cookie to identify a person, and kept the critical information in the local database. But this did not scale well. What if the next request hit a different server? What if you have a zope server and a chat server, the login information would have to be transferred over. What if you have a micro services architecture? So by encrypting the login credentials, and storing them in a cookie, along with time to live information everything works much better.

You can read the detailed documentation [here](./src/cromlech/sessions/jwt/test_session.txt).

In general Cromlech has great detailed documentation, but it is all hidden in the
doc tests. So always look for it there.


4 changes: 0 additions & 4 deletions README.txt

This file was deleted.