blob: 4ae45d115ccd3720f625a61a79aecf158071daf2 [file] [view]
---
title: Security
sidebar_position: 99
id: security
license: |
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---
Use this page when a Swift reader accepts bytes from outside the application's trust boundary.
Fory reconstructs application values; it does not authenticate the sender, protect transport
integrity, or decide whether a valid value is authorized for a business operation.
## Application boundary
Before deserialization:
- Authenticate the sender and protect message integrity at the transport or storage layer.
- Enforce request or file size, timeout, and concurrency limits outside Fory.
- Register only the application types the endpoint accepts and configure the reader before its
first root operation.
- Validate the deserialized value against application authorization and domain rules before use.
## Built-in safeguards
Security-related configuration:
- Register only the expected generated models before deserializing untrusted payloads.
- Use `checkClassVersion` with `compatible: false` for intentional same-schema payloads.
- Set `maxDepth` for the largest nested user-value graph your service accepts. Static recursive
values, dynamic `Any` values, and compatible field skipping share the same root budget.
- Set `maxGraphMemoryBytes` as an approximate gate for collection, map, array, struct, class, and
object-heavy payloads. It is not an exact heap cap; leaf values are gated by remaining input
bytes.
- Keep the remote schema metadata limits at their defaults unless the data is not malicious and a
trusted peer sends larger metadata or many schema versions.
## Verification
Add negative tests for the boundary as well as normal round trips. Verify that the configured reader
rejects unexpected application types, excessive nesting, resource-limit violations, and malformed
input. After a failed read, verify that a valid root can still be read with the same Fory instance.
See [Configuration](configuration.md) for the complete option reference and
[Type Registration](type-registration.md) for the Fory registration API.