lshell 技术文档

本文档旨在帮助用户安装、配置和使用 lshell，一种基于 Python 编写的限制性 shell。lshell 允许您为通过 SSH 访问的用户限制可用的命令集、启用/禁用任何命令（如 SCP、SFTP、rsync 等）、记录用户命令、实施时间限制等功能。

1. 安装指南

1.1 从源代码安装

在 Linux 和 *BSD 系统上，您可以按照以下步骤从源代码安装 lshell：

# 在 Linux 上:
python setup.py install --no-compile --install-scripts=/usr/bin/

# 在 *BSD 上:
python setup.py install --no-compile --install-data=/usr/{pkg,local}/

1.2 在 Debian 及其衍生版本上安装

apt-get install lshell

1.3 在 RHEL 及其衍生版本上安装

yum install lshell

对于 Fedora 和未来版本的 RHEL：

dnf install lshell

2. 项目使用说明

要启动 lshell，只需指定配置文件的位置执行 lshell：

lshell --config /path/to/configuration/file

为了记录用户，您需要将用户添加到 lshell 组中：

usermod -aG lshell username

若要配置用户账户默认使用 lshell，您必须：

chsh -s /usr/bin/lshell user_name

确保 lshell 列在 /etc/shells 中。

3. 项目 API 使用文档

lshell 的配置文件 lshell.conf 提供了一个配置模板。详细的配置信息可以在 /etc/lshell.conf 或 man 文件中找到。

lshell 允许创建具有 SSH 访问权限的 shell 账户，并限制其环境为所需的几个命令和路径。

以下是一个配置文件的示例：

# CONFIGURATION START

[global]
logpath         : /var/log/lshell/
loglevel        : 2

[default]
allowed         : ['ls','pwd']
forbidden       : [';', '&', '|'] 
warning_counter : 2
timer           : 0
path            : ['/etc', '/usr']
env_path        : ':/sbin:/usr/foo'
scp             : 1 # 或 0
sftp            : 1 # 或 0
overssh         : ['rsync','ls']
aliases         : {'ls':'ls --color=auto','ll':'ls -l'}

[grp:users]
warning_counter : 5
overssh         : - ['ls']

[foo]
allowed         : 'all' - ['su']
path            : ['/var', '/usr'] - ['/usr/local']
home_path       : '/home/users'

[bar]
allowed         : + ['ping'] - ['ls'] 
path            : - ['/usr/local']
strict          : 1
scpforce        : '/home/bar/uploads/'

# CONFIGURATION END

4. 项目安装方式

请参考上述“安装指南”中的步骤进行项目安装。