flask-httpauth - מקוון בענן

תָכְנִית:

שֵׁם

flask-httpauth - תיעוד Flask-HTTPAuth

Flask-HTTPAuth הוא הרחבה פשוטה המספקת אימות HTTP Basic ו-Digest
עבור מסלולי Flask.

בסיסי אישור דוגמא

היישום לדוגמה הבא משתמש באימות HTTP Basic כדי להגן על נתיב '/':

מיבוא בקבוק בקבוק
מ-flask.ext.httpauth ייבוא ​​HTTPBasicAuth

app = בקבוק (__ שם__)
auth = HTTPBasicAuth()

משתמשים = {
"john": "שלום",
"סוזן": "ביי"
}

@auth.get_password
def get_pw(שם משתמש):
אם שם משתמש במשתמשים:
החזר users.get(שם משתמש)
להחזיר אף אחד

@app.route('/')
@auth.login_required
def index():
החזר "שלום, %s!" % auth.username()

אם __name__ == '__main__':
app.run ()

השמיים קבל סיסמא התקשרות חוזרת צריכה להחזיר את הסיסמה המשויכת לשם המשתמש שניתן
בתור טיעון. Flask-HTTPAuth יאפשר גישה רק אם get_password(שם משתמש) == סיסמא.

אם הסיסמאות מאוחסנות hash במסד הנתונים של המשתמש, אזי התקשרות חוזרת נוספת היא
דרוש:

@auth.hash_password
def hash_pw(סיסמה):
החזר md5(סיסמה).hexdigest()

כאשר hash_password התקשרות חוזרת ניתנת כאשר גישה תינתן
get_password(שם משתמש) == hash_password(סיסמה).

אם אלגוריתם הגיבוב דורש ששם המשתמש יהיה ידוע, ההתקשרות חזרה יכולה לקחת שניים
טיעונים במקום אחד:

@auth.hash_password
def hash_pw(שם משתמש, סיסמה):
get_salt(שם משתמש)
החזר hash (סיסמה, מלח)

למידת הגמישות הגדולה ביותר קבל סיסמא ו hash_password התקשרות חוזרת יכולה להיות
הוחלף ב verify_password:

@auth.verify_password
def verify_pw(שם משתמש, סיסמה):
החזר call_custom_verify_function(שם משתמש, סיסמה)

לַעכּוֹל אישור דוגמא

הדוגמה הבאה דומה לקודמתה, אבל אימות HTTP Digest כן
מְשׁוּמָשׁ:

מיבוא בקבוק בקבוק
מ-flask.ext.httpauth ייבוא ​​HTTPDigestAuth

app = בקבוק (__ שם__)
app.config['SECRET_KEY'] = 'מפתח סודי כאן'
auth = HTTPDigestAuth()

משתמשים = {
"john": "שלום",
"סוזן": "ביי"
}

@auth.get_password
def get_pw(שם משתמש):
אם שם משתמש במשתמשים:
החזר users.get(שם משתמש)
להחזיר אף אחד

@app.route('/')
@auth.login_required
def index():
החזר "שלום, %s!" % auth.username()

אם __name__ == '__main__':
app.run ()

שים לב שבגלל שאימות Digest מאחסן נתונים ב-Flask's מושב להתנגד ל
התצורה חייבת להיות א מפתח סודי להגדיר.

API תיעוד

בכיתה flask_httpauth.HTTBPasicAuth
מחלקה זו המטפלת באימות HTTP Basic עבור נתיבי Flask.

get_password(password_callback)
פונקציית התקשרות חוזרת זו תיקרא על ידי המסגרת כדי להשיג את
סיסמה עבור משתמש נתון. דוגמא:

@auth.get_password
def get_password(שם משתמש):
החזר db.get_user_password(שם משתמש)

hash_password(hash_password_callback)
אם מוגדרת, פונקציית התקשרות חוזרת זו תיקרא על ידי המסגרת ליישום
אלגוריתם גיבוב מותאם אישית לסיסמה שסופק על ידי הלקוח. אם זה
התקשרות חוזרת לא בתנאי שהסיסמה תיבדק ללא שינוי. ההתקשרות חזרה
יכול לקחת טיעון אחד או שניים. גרסת הטיעון האחד מקבלת את
סיסמה ל-hash, בעוד שגרסת שני הארגומנטים מקבלת את שם המשתמש ו
את הסיסמה לפי הסדר הזה. דוגמה להתקשרות חוזרת של ארגומנט בודד:

@auth.hash_password
def hash_password(סיסמה):
החזר md5(סיסמה).hexdigest()

דוגמה ל-callback של שני ארגומנטים:

@auth.hash_password
def hash_pw(שם משתמש, סיסמה):
get_salt(שם משתמש)
החזר hash (סיסמה, מלח)

verify_password(verify_password_callback)
אם מוגדרת, פונקציית התקשרות חוזרת זו תיקרא על ידי המסגרת לאימות
ששילוב שם המשתמש והסיסמה שסופק על ידי הלקוח תקפים.
פונקציית ההתקשרות חוזרת לוקחת שני ארגומנטים, שם המשתמש והסיסמה ו
חייב לחזור נָכוֹן or לא נכון. שימוש לדוגמא:

@auth.verify_password
def verify_password (שם משתמש, סיסמה):
user = User.query.filter_by(username).first()
אם לא משתמש:
להחזיר שקר
החזר passlib.hash.sha256_crypt.verify(סיסמה, user.password_hash)

שימו לב שכאשר א verify_password התקשרות חוזרת מסופקת קבל סיסמא ו
hash_password לא נעשה שימוש בהתקשרות חוזרת.

error_handler(error_callback)
אם מוגדרת, פונקציית התקשרות חוזרת זו תיקרא על ידי המסגרת כאשר היא
יש צורך לשלוח שגיאת אימות בחזרה ללקוח. השיבה
הערך מפונקציה זו יכול להיות גוף התגובה כמחרוזת או זה
יכול להיות גם אובייקט תגובה שנוצר עם make_response. אם זה התקשרות חזרה
לא בתנאי שנוצרת תגובת שגיאה ברירת מחדל. דוגמא:

@auth.error_handler
def auth_error():
החזר "<h1>גישה נדחתה</h1>"

login_required(view_function_callback)
פונקציית התקשרות חוזרת זו תיקרא כאשר האימות יצליח. זֶה
בדרך כלל תהיה פונקציית תצוגת Flask. דוגמא:

@app.route('/private')
@auth.login_required
def private_page():
חזרה "לאנשים מורשים בלבד!"

שם משתמש()
פונקציית תצוגה המוגנת עם מחלקה זו יכולה לגשת לרשומות
שם משתמש באמצעות שיטה זו. דוגמא:

@app.route('/')
@auth.login_required
def index():
החזר "שלום, %s!" % auth.username()

בכיתה flask.ext.httpauth.HTTPDigestAuth
מחלקה זו המטפלת באימות HTTP Digest עבור נתיבי Flask. ה מפתח סודי
יש להגדיר תצורה ביישום Flask כדי לאפשר להפעלה לעבוד.
Flask כברירת מחדל מאחסנת הפעלות משתמש בלקוח כקובצי Cookie מאובטחים, כך שה
הלקוח חייב להיות מסוגל להתמודד עם עוגיות. כדי לתמוך בלקוחות שאינם דפדפני אינטרנט
או שאינו יכול להתמודד עם עוגיות א מושב ממשק שכותב מפגשים ב-
יש להשתמש בשרת.

get_password(password_callback)
ראה אימות בסיסי לתיעוד ודוגמאות.

error_handler(error_callback)
ראה אימות בסיסי לתיעוד ודוגמאות.

login_required(view_function_callback)
ראה אימות בסיסי לתיעוד ודוגמאות.

שם משתמש()
ראה אימות בסיסי לתיעוד ודוגמאות.

השתמש ב-flask-httpauth באופן מקוון באמצעות שירותי onworks.net