Compare commits
No commits in common. "lecture_notes" and "main" have entirely different histories.
lecture_no
...
main
3 changed files with 0 additions and 167 deletions
37
README.md
37
README.md
|
@ -15,40 +15,3 @@
|
||||||
|
|
||||||
— Lars Wirzenius (Linux kernel developer)
|
— Lars Wirzenius (Linux kernel developer)
|
||||||
|
|
||||||
## Warm-Up
|
|
||||||
- how to start a repo from scratch?
|
|
||||||
- `git init` local method
|
|
||||||
- on an online forge (GitHub, GitLab, …): `git clone`
|
|
||||||
- how to revert mistakes?
|
|
||||||
- before commit:
|
|
||||||
- `git restore <file>` [discard changes in the working directory] __changes files__
|
|
||||||
- `git restore --staged <file>` [unstage changes ➔ opposite of `git add <file>`, does not modify the working directory]
|
|
||||||
- after commit:
|
|
||||||
- `git revert <commit>` [creates a new commit, modifies the working directory]
|
|
||||||
- `git reset <commit>` [only reset the HEAD pointer, does not modify the working directory] __rewrites history__ ➔ can not be used if you have already pushed to some remote
|
|
||||||
- `git reset --hard <commit>` [reset HEAD and modify working directory] __rewrites history__ and __changes files__ ➔ can not be used if you have already pushed to some remote
|
|
||||||
- how to *move* the whole working directory to a specific point in history?
|
|
||||||
- `git checkout <commit>` ➔ `DETACHED HEAD` problem, __changes__ __files__
|
|
||||||
- interaction with branches: `git branch <branch_name>` + `git switch <branch_name>`
|
|
||||||
- how to copy a file from a different branch:
|
|
||||||
- `git checkout <branch> <file>` ➔ the file is staged automatically
|
|
||||||
- `git restore --source=<branch> <file` ➔ the file is not staged
|
|
||||||
- `git gui`: building commits along the way interactively (for the *mess around* type of workflows)
|
|
||||||
- check out these [sketches](git-commands-visualizations.pdf) for a graphical visualization of git commands!
|
|
||||||
|
|
||||||
## Workflows
|
|
||||||
Look at the [sketches](workflow_sketches.pdf)
|
|
||||||
|
|
||||||
1. **lone scientist local** ➔ working alone in the cellar without Internet (local git)
|
|
||||||
2. **lone scientist remote** ➔ uploading their software to the Internet in the hope it can be useful for other people (local git + one personal repo on a git-forge)
|
|
||||||
3. **research group** ➔ sharing one software project with some other befriended scientist working in a different place (local git + group repo on a git-forge + permissions)
|
|
||||||
4. **fully distributed software development** ➔ using the most typical open source software workflows as used by numpy, scipy, sklearn, etc. (like above + we don't trust our contributors, i.e. work strictly with forks)
|
|
||||||
|
|
||||||
## The Open Source workflow
|
|
||||||
- remotes: `git pull <from_where> <what>`, `git push <where> <what>`, `git fetch <from_where> <what>`, `git merge <another_branch>`
|
|
||||||
- git-forge: forks, branches and PRs: notice the difference between `fork` and `clone`!!!
|
|
||||||
- strategies for keeping your fork up-to-date: your `main`, origin's and upstream's `main`, short-lived and long-lived topic branches
|
|
||||||
- a more thorough and detailed explanation can be found on the [SciPy Contributor's Guide](https://docs.scipy.org/doc/scipy/dev/gitwash/gitwash.html). This guide can be adapted to your own needs, see [gitwash](https://github.com/matthew-brett/gitwash).
|
|
||||||
- GitHub and GitLab are just options (git≠GitHub): there are many git-forges out there, both installable on premises (e.g. [forgejo](https://forgejo.org/)) ) or as an online service for free and open source software (e.g. [codeberg](https://codeberg.org/)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
88
auth.py
88
auth.py
|
@ -1,88 +0,0 @@
|
||||||
import getpass
|
|
||||||
import json
|
|
||||||
import pathlib
|
|
||||||
import random
|
|
||||||
import string
|
|
||||||
import sys
|
|
||||||
|
|
||||||
# name of the file where we store the pw database
|
|
||||||
PWDB_FLNAME = pathlib.Path('pwdb.json')
|
|
||||||
|
|
||||||
# list of valid characters for salt (only ASCII letters + digits + punctuation)
|
|
||||||
CHARS = string.ascii_letters + string.digits + string.punctuation
|
|
||||||
|
|
||||||
# length of salt
|
|
||||||
SALT_LENGTH = 5
|
|
||||||
|
|
||||||
def get_credentials():
|
|
||||||
# get input from terminal
|
|
||||||
username = input('Enter your username: ')
|
|
||||||
# get password using the appropriate module, so that typed characters are not
|
|
||||||
# echoed to the terminal
|
|
||||||
password = getpass.getpass('Enter your password: ')
|
|
||||||
return (username, password)
|
|
||||||
|
|
||||||
def authenticate(username, pass_text, pwdb):
|
|
||||||
# get the salt from the database
|
|
||||||
salt = pwdb[username][1]
|
|
||||||
# calculate hash and compare with stored hash
|
|
||||||
return pwhash(pass_text, salt) == pwdb[username][0]
|
|
||||||
|
|
||||||
def add_user(username, pwdb):
|
|
||||||
# do not try to add a username twice
|
|
||||||
if username in pwdb:
|
|
||||||
raise Exception(f'Username already exists [{username}]!')
|
|
||||||
else:
|
|
||||||
password = getpass.getpass(f'Enter password for {username}: ')
|
|
||||||
salt = get_salt()
|
|
||||||
pwdb[username] = (pwhash(password,salt), salt)
|
|
||||||
return pwdb
|
|
||||||
|
|
||||||
def read_pwdb(pwdb_path):
|
|
||||||
if not pwdb_path.exists():
|
|
||||||
pwdb = {}
|
|
||||||
else:
|
|
||||||
with open(pwdb_path, 'rt') as pwdb_file:
|
|
||||||
pwdb = json.load(pwdb_file)
|
|
||||||
return pwdb
|
|
||||||
|
|
||||||
def write_pwdb(pwdb, pwdb_path):
|
|
||||||
with open(pwdb_path, 'wt') as pwdb_file:
|
|
||||||
json.dump(pwdb, pwdb_file)
|
|
||||||
|
|
||||||
def pwhash(pass_text, salt):
|
|
||||||
# simple additive hash -> very insecure!
|
|
||||||
hash_ = 0
|
|
||||||
full_pass_text = pass_text + salt
|
|
||||||
for idx, char in enumerate(full_pass_text):
|
|
||||||
# use idx as a multiplier, so that shuffling the characters returns a
|
|
||||||
# different hash
|
|
||||||
hash_ += (idx+1)*ord(char)
|
|
||||||
return hash_
|
|
||||||
|
|
||||||
def get_salt():
|
|
||||||
salt_chars = random.choices(CHARS, k=SALT_LENGTH)
|
|
||||||
return ''.join(salt_chars)
|
|
||||||
|
|
||||||
def main(pwdb_path):
|
|
||||||
# load the password database from file
|
|
||||||
pwdb = read_pwdb(pwdb_path)
|
|
||||||
|
|
||||||
# if we are passed an argument, we want to add a new user
|
|
||||||
if len(sys.argv) > 1:
|
|
||||||
pwdb = add_user(sys.argv[1], pwdb)
|
|
||||||
write_pwdb(pwdb, pwdb_path)
|
|
||||||
return
|
|
||||||
|
|
||||||
# ask for credentials
|
|
||||||
username, password = get_credentials()
|
|
||||||
if username not in pwdb or not authenticate(username, password, pwdb):
|
|
||||||
print('Wrong username or password!')
|
|
||||||
else:
|
|
||||||
print('Successfully authenticated!')
|
|
||||||
|
|
||||||
return
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
main(PWDB_FLNAME)
|
|
||||||
|
|
|
@ -1,42 +0,0 @@
|
||||||
import json
|
|
||||||
import sys
|
|
||||||
|
|
||||||
def get_credentials():
|
|
||||||
username = input('Enter your username: ')
|
|
||||||
password = input('Enter your password: ')
|
|
||||||
return (username, password)
|
|
||||||
|
|
||||||
def authenticate(username, password, pwdb):
|
|
||||||
return password == pwdb[username]
|
|
||||||
|
|
||||||
def add_user(username, pwdb):
|
|
||||||
pwdb[username] = input(f'Enter password for {username}: ')
|
|
||||||
return pwdb
|
|
||||||
|
|
||||||
def read_pwdb(pwdb_path):
|
|
||||||
try:
|
|
||||||
pwdb_file = open(pwdb_path, 'rt')
|
|
||||||
pwdb = json.load(pwdb_file)
|
|
||||||
except Exception:
|
|
||||||
pwdb = {}
|
|
||||||
return pwdb
|
|
||||||
|
|
||||||
def write_pwdb(pwdb, pwdb_path):
|
|
||||||
pwdb_file = open(pwdb_path, 'wt')
|
|
||||||
json.dump(pwdb, pwdb_file)
|
|
||||||
|
|
||||||
pwdb_path = 'pwdb.json'
|
|
||||||
pwdb = read_pwdb(pwdb_path)
|
|
||||||
|
|
||||||
if len(sys.argv) > 1:
|
|
||||||
pwdb = add_user(sys.argv[1], pwdb)
|
|
||||||
write_pwdb(pwdb, pwdb_path)
|
|
||||||
else:
|
|
||||||
username, password = get_credentials()
|
|
||||||
if username not in pwdb:
|
|
||||||
print('Wrong username!')
|
|
||||||
else:
|
|
||||||
if authenticate(username, password, pwdb):
|
|
||||||
print('Successfully authenticated!')
|
|
||||||
else:
|
|
||||||
print('Wrong password!')
|
|
Loading…
Add table
Add a link
Reference in a new issue