بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 27: خطا، لاگ و رازها Errors, Logs and Secrets

وقتی سرور واقعی خراب می‌شود، غریبه‌ها نباید متن خطای پایتون را ببینند. با app.debug = False خرابی فقط یک 500 ساده است و جزئیاتش در app.logs می‌ماند که فقط خودت می‌خوانی. یاد می‌گیری در لاگ چه بنویسی و چه ننویسی، هش، توکن و ایمیل کسی را در جواب نفرستی، رازها را از کد بیرون نگه داری، و ایده‌ی HTTPS و CORS را می‌شناسی.

در این جلسه یاد می‌گیری

درس

🔐 قانون طلایی این دوره: سرور امانت‌دار است. هر سروری که می‌سازی داده‌ی آدم‌ها را نگه می‌دارد: اسم، امتیاز، یادداشت، رمز. پس به هر چه از بیرون می‌آید شک کن، رمز را هیچ‌وقت خام نگه ندار و داده‌ی کسی را به دیگری نشان نده. فقط سرورهای خودت را امتحان کن. سرور این دوره ساختگی است و داخل همین صفحه کار می‌کند: هر بار که برنامه را اجرا می‌کنی از صفر ساخته می‌شود، پس هر چه می‌خواهی امتحان کن.

یادت هست؟ در جلسه‌ی ۲۱ گفتیم سرور هش رمز را هیچ‌وقت در جواب برنمی‌گرداند، و در جلسه‌ی ۲۵ فقط فیلدهای مجاز را از کلاینت گرفتیم. ثبت‌نام پایین هر دو را دارد: role کلاینت نادیده گرفته می‌شود و جواب فقط name و role است. امروز همین فکر را برای همه‌ی جواب‌ها، پیام‌های خطا و لاگ‌ها به کار می‌بریم.

from server import app, ask, request, abort, hash_password

users = {}


@app.post("/signup")
def signup():
    data = request.json or {}
    name = data.get("name", "")
    if name in users:
        abort(409, "that name is taken")
    users[name] = {"name": name, "hash": hash_password(data.get("password", "")), "role": "member"}
    return {"name": name, "role": "member"}, 201


ask("POST /signup", {"name": "sara", "password": "cat123", "role": "admin"})
ask("POST /signup", {"name": "sara", "password": "dog456"})

خرابی در سرور واقعی. تا حالا وقتی routeی خراب می‌شد، برنامه با خطای کامل پایتون (خط، فایل، نوع خطا) می‌ایستاد. موقع ساختن عالی است، چون می‌بینی کجا را درست کنی. ولی روی سرور واقعی آن متن به دست غریبه می‌رسد: اسم فایل‌ها، تکه‌ای از کد و گاهی حتی یک راز را لو می‌دهد و نقشه‌ی راه کسی است که دنبال حفره می‌گردد. با app.debug = False سرور ما مثل سرور واقعی رفتار می‌کند: کلاینت فقط 500 و {"error": "something went wrong on the server"} می‌گیرد و جزئیات خطا یک خط در فهرست app.logs می‌شود که فقط خودت می‌بینی. این تور ایمنی است، نه درمان: بعد از دیدن لاگ، باگ را درست کن (مثلاً 404 برای اسم ناشناخته).

from server import app, ask

app.debug = False
scores = {"sara": [120, 150], "kian": []}


@app.get("/average/<name>")
def average(name):
    s = scores[name]
    return {"name": name, "average": sum(s) / len(s)}


ask("GET /average/sara")
ask("GET /average/kian")
ask("GET /average/nima")
for line in app.logs:
    print("LOG:", line)

لاگ خوب، لاگ بد. app.logs یک فهرست معمولی است و خودت هم می‌توانی خط اضافه کنی: app.logs.append("..."). یک لاگ خوب می‌گوید چه کسی، چه کاری، کِی و از کدام نشانی: login failed: sara from 198.51.100.7 at 3. این‌طوری بعداً می‌بینی کسی دارد رمز حدس می‌زند. ولی در لاگ هرگز این‌ها را ننویس: رمز (حتی رمز غلط؛ رمز غلط معمولاً همان رمز درست با یک غلط تایپی است، یا رمز همان آدم در سایت دیگری)، توکن و هش. لاگ را آدم‌های بیشتری می‌بینند و دیرتر پاک می‌شود.

from server import app, ask, request, abort, hash_password, check_password, now, wait

users = {"sara": hash_password("cat123")}


@app.post("/login")
def login():
    data = request.json or {}
    name = data.get("name", "")
    stored = users.get(name)
    if stored is None or not check_password(data.get("password", ""), stored):
        app.logs.append("login failed: " + name + " from " + request.ip + " at " + str(int(now())))
        abort(401, "wrong name or password")
    return {"message": "welcome " + name}


ask("POST /login", {"name": "sara", "password": "cat12"}, ip="198.51.100.7")
wait(3)
ask("POST /login", {"name": "sara", "password": "cat1234"}, ip="198.51.100.7")
for line in app.logs:
    print("LOG:", line)

فقط فیلدهای عمومی. جدول کاربرها چیزهای خصوصی دارد: هش، ایمیل، توکن. اگر route کل ردیف را برگرداند (return user)، همه‌اش به همه می‌رسد. یک تابع کوچک بنویس که نسخه‌ی عمومی را بسازد: def public(user): return {"name": ..., "level": ...}. این هم یک فهرست مجاز است، این بار برای چیزی که بیرون می‌رود. چرا نه «همه‌چیز جز هش»؟ چون فردا کسی ستون phone را اضافه می‌کند و بی‌صدا لو می‌رود. ایمیل یا شماره‌ی هر کس فقط به خود او نشان داده می‌شود (با توکنش، مثل فاز ۶).

from server import app, ask, hash_password

users = [
    {"name": "mina", "email": "mina@example.com", "hash": hash_password("cat123"), "level": 9},
    {"name": "omid", "email": "omid@example.com", "hash": hash_password("dog456"), "level": 6},
]


def public(user):
    return {"name": user["name"], "level": user["level"]}


@app.get("/players")
def players():
    result = []
    for u in users:
        result.append(public(u))
    return result


ask("GET /players")

رازها بیرون از کد. سرورها رازهایی دارند: رمز پایگاه داده، کلید یک سرویس پیامک، رمز مدیر. اگر آن را در کد بنویسی، هر کس کد را ببیند رازت را دارد: در گیت‌هاب، در اسکرین‌شاتی که برای دوستت فرستادی، در فایلی که به معلم دادی. سرورهای واقعی رازها را از متغیرهای محیطی (environment variables) می‌خوانند که روی خود سرور تنظیم شده‌اند، نه در کد:

``python
import os
SMS_KEY = os.environ.get("SMS_KEY")
`

و فایل رازها (مثل
.env) را در .gitignore` می‌گذارند تا هرگز به گیت نرود. اگر رازی لو رفت، فقط پاک کردن آن خط کافی نیست (گیت تاریخچه را یادش هست): فوراً یک راز تازه بساز و قبلی را باطل کن.

دو ایده برای بعد: HTTPS و CORS. سرور ساختگی ما داخل صفحه است، ولی سرور واقعی روی اینترنت است و این دو را لازم دارد:
- HTTPS: درخواست بین گوشی و سرور از دست خیلی‌ها رد می‌شود (وای‌فای کافه، مودم‌ها). بدون HTTPS مثل کارت‌پستال است و هر کس سر راه رمز و توکن را می‌خواند یا جواب را عوض می‌کند. HTTPS آن را در پاکت قفل‌شده می‌گذارد. نشانه‌اش قفل کنار آدرس است. هر سروری که رمز یا توکن می‌گیرد باید HTTPS باشد.
- CORS: قانونی در مرورگر. صفحه‌ی یک سایت دیگر که در همان مرورگر باز است نباید بتواند جواب‌های API تو را بخواند. سرور با سرآیند Access-Control-Allow-Origin می‌گوید صفحه‌های کدام سایت اجازه دارند (مثلاً فقط https://quiz.example.com)؛ برای داده‌ی خصوصی، * (یعنی همه) نه.
در جلسه‌ی ۳۲ می‌بینی سرور کوییز چطور با HTTPS آنلاین می‌شود.

اشتباه‌های رایج:
- پیام خطایی که زیادی می‌گوید: «کاربری به اسم mina نداریم» و «رمز sara غلط است» به غریبه می‌گوید کدام اسم‌ها وجود دارند. یک پیام برای هر دو: wrong name or password.
- فرستادن str(err) یا متن خطای پایتون به کلاینت. جای آن app.logs است، نه جواب.
- نوشتن رمز یا توکن در لاگ «فقط برای اشکال‌یابی».
- روشن ماندن debug روی سرور واقعی.
- return user به‌جای return public(user).

مثال‌های این جلسه

چالش‌ها

  1. The Right Sign-Up Answer (آسان)
  2. A Safety Net (آسان)
  3. HTTPS or CORS? (متوسط)
  4. The Public Profile (متوسط)
  5. A Login That Says Too Much (سخت)
  6. Your Email Is Yours (سخت)

بیشتر بخوان

← جلسه‌ی 26: درخواست زیادی: محدودیت سرعت جلسه‌ی 28: پروژه: قفل کردن یک API →