ungleich-public/ungleich-otp
6
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[django] add model

Browse source
This commit is contained in:
Nico Schottelius 2018-10-26 21:48:21 +02:00
parent f237c1fcbb
commit 13c7cdd294
2 changed files with 45 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -19,10 +19,10 @@ In development, pre production.
## Usage: BUS ## Usage: BUS
### RPC: verify(appid, token, appidtoverify, tokentoverify) ### RPC: verify(appuuid, token, appuuidtoverify, tokentoverify)
Verify whether the requesting app is authenticated. This is only Verify whether the requesting app is authenticated. This is only
allowed to be used for trusted appids. allowed to be used for trusted appuuids.
Returns a JSON object: Returns a JSON object:
@ -57,10 +57,10 @@ Request JSON object:
``` ```
{ {
version: "1", version: "1",
appid: "your-app-uuid", appuuid: "your-app-uuid",
token: "current time based token", token: "current time based token",
appidtoverify: "appid that wants to be authenticated", appuuidtoverify: "appuuid that wants to be authenticated",
tokentoverify: "current time based token of appidtoverify", tokentoverify: "current time based token of appuuidtoverify",
} }
``` ```
@ -89,7 +89,7 @@ Request JSON object:
{ {
version: "1", version: "1",
appid: "your-app-uuid", appuuid: "your-app-uuid",
token: "current time based token", token: "current time based token",
username: "user this app belongs to", username: "user this app belongs to",
appname: "name of your web app" appname: "name of your web app"
@ -100,7 +100,7 @@ Response JSON object:
``` ```
{ {
status: "OK", status: "OK",
appid: "UUID of your app", appuuid: "UUID of your app",
} }
``` ```
@ -121,7 +121,7 @@ Request JSON object:
{ {
version: "1", version: "1",
appid: "your-app-uuid", appuuid: "your-app-uuid",
token: "current time based token" token: "current time based token"
} }
@ -133,11 +133,11 @@ Response JSON object:
apps: [ apps: [
{ {
name: "name of your web app" name: "name of your web app"
appid: "UUID of your app", appuuid: "UUID of your app",
}, },
{ {
name: "name of your second web app" name: "name of your second web app"
appid: "UUID of your second app", appuuid: "UUID of your second app",
} }
] ]
} }
@ -152,7 +152,7 @@ Request JSON object:
``` ```
{ {
version: "1", version: "1",
appid: "your-app-uuid", appuuid: "your-app-uuid",
token: "current time based token" token: "current time based token"
} }
``` ```
@ -175,13 +175,36 @@ apps.
## Database ## Database
The database saves a list of appids with their seeds and the user The database saves a list of appuuids with their seeds and the user
assignments as well as whether the appid might use the BUS interface. assignments as well as whether the appuuid might use the BUS interface.
Fields: Fields:
- appuuid (a random UUID)
- appname (name chosen by the user) - appname (name chosen by the user)
- appid (a random UUID) - username (who this appuuid belongs to)
- seed (a random base32 string) - seed (a random base32 string)
- username (who this appid belongs to) - trusted (boolean, whether app is allowed to use the BUS and the
- trusted (boolean, whether app is allowed to use the BUS) verify method)
## Environment / Configuration
- POSTGRES_USERNAME
- SECRET_KEY -- random
## Random notes / stuff
django.db.backends.postgresql
django.contrib.admin
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'mydatabase',
'USER': 'mydatabaseuser',
'PASSWORD': 'mypassword',
'HOST': '127.0.0.1',
'PORT': '5432',
}
}

6
ungleichotp/otpauth/models.py
View file

@ -1,3 +1,9 @@
from django.db import models from django.db import models
# Create your models here. # Create your models here.
class OTPSeed(models.Model):
appuuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
appname = models.CharField(max_length=128)
username = models.CharField(max_length=128)
seed = models.CharField(max_length=128)
trusted = models.BooleanField(default=False)