Secure Coding & OWASP Top 10 for Backend · 课时

设计安全的 RESTful API

为 RESTful API 实施安全最佳实践，包括身份验证、授权、速率限制和输入验证。

设计安全的 RESTful API 是 CoddyKit 上的免费 Secure Coding & OWASP Top 10 for Backend 课时。这是第 1 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Secure Coding & OWASP Top 10 for Backend 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Secure Coding & OWASP Top 10 for Backend 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

APIs Need Strong Security

RESTful APIs are the backbone of modern applications, connecting different services and clients. They expose your backend logic and data to the world, making them prime targets for attackers.

Securing your APIs is not an option; it's a necessity. A single vulnerability can lead to data breaches, service disruptions, or unauthorized access.

Who Are You? API Authentication

Authentication is the process of verifying a client's identity. For APIs, this often means checking if the client has permission to make requests.

API Keys: Simple secrets sent with requests.
Tokens (e.g., JWTs): More robust, often used for user authentication flows.
OAuth 2.0: For delegated authorization (covered in another lesson).

Always use strong, unique credentials and protect them.

Using API Keys for Access

API keys are unique identifiers used to authenticate a project or user. They are usually sent in the request header or as a query parameter.

While simple, they should be treated like passwords. Never hardcode them and revoke them immediately if compromised.

Example of sending an API key:

public class ApiClient {
  public static void main(String[] args) {
    String apiKey = "your_secret_api_key_123";
    String url = "https://api.example.com/data";

    System.out.println("Sending request to: " + url);
    System.out.println("With header: X-API-Key: " + apiKey);
    // In a real app, you'd use HttpClient to send the request
  }
}

What Are You Allowed To Do?

After authentication, authorization determines what an authenticated client can do. An authenticated user might be allowed to read data, but not delete it.

Role-Based Access Control (RBAC): Assigning permissions based on roles (e.g., 'admin', 'user').
Attribute-Based Access Control (ABAC): More granular, using attributes of the user, resource, or environment.

Always apply the principle of least privilege: grant only the minimum necessary access.

Never Trust User Input

Every piece of data that enters your API from an external source must be validated. This includes query parameters, headers, and request bodies.

Proper input validation helps prevent many attacks, such as:

Injection attacks: (SQLi, Command Injection)
Cross-Site Scripting (XSS): (Though often client-side, backend can contribute)
Buffer overflows and other data integrity issues.

Define strict rules for data types, length, format, and acceptable values.

Simple Input Validation Example

Here's a basic Java example of validating a username. A real-world application would have more complex validation rules, potentially using a dedicated validation library.

public class InputValidator {
  public static void main(String[] args) {
    String username1 = "validUser123";
    String username2 = "invalid user!";
    String username3 = "tooLongUsernameWhichExceedsTwentyChars";

    System.out.println("Validating '" + username1 + "': " + isValidUsername(username1));
    System.out.println("Validating '" + username2 + "': " + isValidUsername(username2));
    System.out.println("Validating '" + username3 + "': " + isValidUsername(username3));
  }

  public static boolean isValidUsername(String username) {
    if (username == null || username.trim().isEmpty()) {
      return false; // Cannot be null or empty
    }
    if (username.length() < 3 || username.length() > 20) {
      return false; // Length check
    }
    // Only alphanumeric characters allowed
    if (!username.matches("^[a-zA-Z0-9]+$")) {
      return false;
    }
    return true;
  }
}

Control Request Flow with Rate Limiting

Rate limiting restricts the number of requests a client can make to an API within a specific time frame (e.g., 100 requests per minute).

This is crucial for:

Preventing DoS (Denial of Service) attacks: Overwhelming your server.
Mitigating brute-force attacks: On authentication endpoints.
Ensuring fair usage: Preventing a single client from monopolizing resources.

When limits are exceeded, the API should return an HTTP 429 Too Many Requests status code.

Handle Errors Securely

How your API handles errors is a security consideration. Detailed error messages can inadvertently leak sensitive information about your backend, such as database schemas, server paths, or internal logic.

Best practices:

Generic Error Messages: Provide high-level, user-friendly errors.
Log Details Internally: Keep detailed error logs on the server, not in the client response.
Avoid Stack Traces: Never expose raw stack traces to clients.

Use standard HTTP status codes (e.g., 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error).

Always Use HTTPS (TLS/SSL)

All communication with your RESTful API must occur over HTTPS (HTTP Secure). HTTPS encrypts the data exchanged between the client and the server, protecting it from eavesdropping, tampering, and man-in-the-middle attacks.

Ensure your server is configured with valid TLS/SSL certificates and that clients are forced to use HTTPS (e.g., HSTS headers).

This is a fundamental layer of security for any web-facing service.

Check Your API Security Knowledge

Which of the following are essential security practices when designing RESTful APIs?

Recap: Designing Secure APIs

In this lesson, we covered key principles for designing secure RESTful APIs:

Authentication: Verifying client identity (e.g., API keys).
Authorization: Controlling what authenticated clients can do.
Input Validation: Strictly validating all incoming data.
Rate Limiting: Preventing abuse and DoS attacks.
Secure Error Handling: Avoiding information disclosure.
HTTPS: Encrypting all communication.

By applying these practices, you build more robust and trustworthy APIs.

常见问题解答

「设计安全的 RESTful API」课时是免费的吗？

是的 — 「设计安全的 RESTful API」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Secure Coding & OWASP Top 10 for Backend 课程的其余内容，请升级到 CoddyKit PRO。 Secure Coding & OWASP Top 10 for Backend 课程共包含 4 节课。

「设计安全的 RESTful API」这节课中我会学到什么？

为 RESTful API 实施安全最佳实践，包括身份验证、授权、速率限制和输入验证。你通过在浏览器中直接运行的动手代码来练习 Secure Coding & OWASP Top 10 for Backend，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Secure Coding & OWASP Top 10 for Backend 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Secure Coding & OWASP Top 10 for Backend 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 1 节课，共 4 节。

「设计安全的 RESTful API」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Secure Coding & OWASP Top 10 for Backend 课中编写并运行代码吗？

能。每节 Secure Coding & OWASP Top 10 for Backend 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Secure Coding & OWASP Top 10 for Backend