docs/app/federation/validation/page.mdx

37 lines
2.8 KiB
Plaintext
Raw Normal View History

2024-07-27 15:37:58 +02:00
export const metadata = {
title: 'Validation',
description:
'Validation rules for Versia implementations.',
2024-07-27 15:37:58 +02:00
}
# Validation
Implementations **MUST** strictly validate all incoming data to ensure that it is well-formed and adheres to the Versia Protocol. If a request is invalid, the instance **MUST** return a `422 Unprocessable Entity` HTTP status code.
2024-07-27 15:37:58 +02:00
<Note>
Remember that while *your* implementation may disallow or restrict some user input, other implementations may not. You **should not** apply those restrictions to data coming from other instances.
For example, if your implementation disallows using HTML in posts, you should not strip HTML from posts coming from other instances. You *may* choose to display them differently, but you should not modify the data itself.
</Note>
Things that should be validated include, but are not limited to:
- The presence of **all required fields**, and the presence of `null` on optional fields.
- The **format** of all fields (integers should not be strings, timestamps should be in RFC 3339 format, etc.).
2024-07-27 15:37:58 +02:00
- The presence of **all required headers**.
- The presence of a **valid signature**.
2024-07-31 20:56:42 +02:00
- The **length** of all fields (for example, the `username` field on a `User` entity) should be at least 1 character long.
2024-07-27 15:37:58 +02:00
- Do not set arbitrary limits on the length of fields that other instances may send you. For example, a `bio` field should not be limited to 160 characters, even if your own implementation has such a limit.
- If you do set limits, they should be reasonable, well-documented and should allow Users to easily view the remote original, by, for example, linking to it. A limit of `100 000` characters for a `bio` field is acceptable, but a limit of `160` characters is not.
2024-07-27 15:37:58 +02:00
- The **type**, **precision** and **scale** of all numeric fields.
- For example, a `size` field on a `ContentFormat` structure should be a positive integer, not a negative number or a floating-point number.
<Note>
All numeric fields in these docs have the appropriate precision (`u64`, `i64`, `f32`, etc.) specified. As a rule of thumb, do not use a different type in memory than the one specified in the docs.
Using the same type with a higher bit count, for example using a u128 instead of a u64, is acceptable. Beware of performance impacts this may cause.
</Note>
- The **validity** of all URLs and URIs (run them through your favorite URL parser).
2024-07-27 15:37:58 +02:00
- The **time** of all dates and times (people should not be born in the future, or in the year 0).
It is your implementation's duty to reject data from other instances that does not adhere to the strict spec. **This is crucial to ensure the integrity of your instance and the network as a whole**. Allowing data that is technically valid but semantically incorrect can lead to the degradation of the entire Versia ecosystem.