Landrun 项目使用教程

Landrun 项目使用教程

landrun Run any Linux process in a secure, unprivileged sandbox using Landlock LSM. Think firejail, but lightweight, user-friendly, and baked into the kernel. 项目地址: https://gitcode.com/gh_mirrors/la/landrun

1. 项目目录结构及介绍

Landrun 项目的主要目录结构如下：

landrun/
├── .github/          # GitHub 工作流和配置文件
│   └── workflows/
├── cmd/             # 主执行命令所在的目录
│   └── landrun/
├── internal/        # 内部模块和库
├── .gitignore       # 指定 git 忽略的文件和目录
├── LICENSE          # 项目许可证文件
├── README.md        # 项目说明文件
├── demo.gif         # 项目演示动画文件
├── go.mod           # Go 依赖管理文件
├── go.sum           # Go 依赖校验文件
├── test.sh          # 测试脚本

• .github/workflows/：包含 GitHub Actions 工作流文件，用于自动化项目的一些操作，如代码测试、构建等。
• cmd/landrun/：包含项目的主程序，即 landrun 命令的实现代码。
• internal/：包含项目内部使用的库和模块。
• .gitignore：列出在 Git 版本控制中应忽略的文件和目录。
• LICENSE：项目使用的许可证信息，本项目采用 MIT 许可证。
• README.md：项目的详细说明文件，介绍了项目的功能、使用方法等。
• demo.gif：项目的功能演示动画。
• go.mod 和 go.sum：Go 语言的依赖管理文件，用于管理项目依赖的第三方库。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/landrun/main.go。这是项目的入口点，它定义了 main 函数，并负责解析命令行参数，设置沙盒环境，然后执行指定的命令。

package main

import (
    "github.com/zouuup/landrun/cmd/landrun"
)

func main() {
    landrun.Execute()
}

在这个文件中，我们调用了 landrun.Execute() 函数来启动程序。这个函数会处理所有的命令行参数，并执行用户指定的操作。

3. 项目的配置文件介绍

Landrun 项目不使用传统的配置文件，而是通过命令行参数来配置沙盒的环境。命令行参数包括：

• --ro <path>：允许只读访问指定的路径。
• --rox <path>：允许只读访问和执行指定路径。
• --rw <path>：允许读写访问指定的路径。
• --rwx <path>：允许读写访问和执行指定路径。
• --bind-tcp <port>：允许绑定到指定的 TCP 端口。
• --connect-tcp <port>：允许连接到指定的 TCP 端口。
• --env <var>：传递环境变量给沙盒中的命令。
• 其他参数如 --best-effort、--log-level、--unrestricted-network 和 --unrestricted-filesystem 用于控制沙盒的其他行为。

用户可以通过命令行传递这些参数来定制沙盒环境，例如：

landrun --rox /usr/ --ro /lib,/lib64 --bind-tcp 8080 --connect-tcp 80 /usr/bin/my-server

以上命令会创建一个沙盒环境，允许 my-server 命令以只读和执行权限访问 /usr/ 目录，只读访问 /lib/ 和 /lib64/ 目录，并且只能绑定到 TCP 端口 8080 以及连接到 TCP 端口 80。

landrun Run any Linux process in a secure, unprivileged sandbox using Landlock LSM. Think firejail, but lightweight, user-friendly, and baked into the kernel. 项目地址: https://gitcode.com/gh_mirrors/la/landrun