# `naisi_file_hash`

以流式方式计算调用方指定本地普通文件的 SHA-256 或分块内容摘要。

路径必须位于许可证允许的文件根或系统临时目录，且拒绝符号链接、重解析点和非普通文件；
不限制文件大小，也不会把整个文件一次性载入内存；函数不读取许可或密钥文件内容。

## 函数签名

```php
function naisi_file_hash(string $file_name, int $algorithm = NAISI_FILE_HASH_SHA256): string|false
```

## 调用前提

应用入口先调用 [naisi_is_ext_license_valid](/web/developers/naisilib/naisi-is-ext-license-valid) 并确认返回 `true`。只验证同一请求内已有的有效 FULL/BASIC 证明；没有证明或证明失效时立即返回失败值，不现场补做完整校验。

授权类别：`LOCAL_FILE_METADATA`；执行模式：`PROOF`。许可不代替登录、租户或权限上下文；身份与数据要求见本页参数及用途说明。

## 参数

### `$file_name`

- 类型：`string`
- 必填：是
- 默认值：无
- 方向：输入参数。

许可授权目录或当前环境临时目录内需要计算摘要的绝对普通文件路径；拒绝相对路径以及 .、.. 路径段。

### `$algorithm`

- 类型：`int`
- 必填：否
- 默认值：`NAISI_FILE_HASH_SHA256`
- 方向：输入参数。

摘要算法；NAISI_FILE_HASH_SHA256 返回 SHA-256，NAISI_FILE_HASH_QETAG 按 4 MiB 分块、SHA-1 与 URL-safe Base64 规则生成 QETAG。

## 返回值

类型：`string|false`

默认返回 64 个小写十六进制字符组成的 SHA-256；分块模式返回 28 个 URL-safe Base64 字符，失败时返回 false。

## 关联常量

- [`NAISI_FILE_HASH_SHA256`](/web/developers/naisilib/const#naisi-file-hash-sha256) = `1` — SHA-256 文件摘要算法。 要求 naisi_file_hash() 返回 64 个小写十六进制字符组成的 SHA-256。
- [`NAISI_FILE_HASH_QETAG`](/web/developers/naisilib/const#naisi-file-hash-qetag) = `2` — QETAG 文件摘要算法。 要求 naisi_file_hash() 使用 4 MiB 分块、SHA-1 和 URL-safe Base64 规则返回 QETAG。

## 调用示例

当前请求须满足上方调用前提；请检查实际返回值和引用输出，随机结果及数据包内容以运行环境为准。

```php
$file_name = 'C:\\WINDOWS\\TEMP\\naisi_fun_test\\sample.txt';
$algorithm = 1;

$result = naisi_file_hash($file_name, $algorithm);
var_dump($result);
```

## 版本信息

- 自版本：`1.0.6`
- 实现模块：`filesystem`
- 授权类别：`LOCAL_FILE_METADATA` / `PROOF`
- 失败回退：`false`
- 文档同步：`2026-10-18`