首页
/ Libcli 技术文档

Libcli 技术文档

2024-12-23 12:59:55作者:幸俭卉

1. 安装指南

要编译并安装 Libcli 库,请按照以下步骤操作:

$ make
$ make install

请注意,从版本 1.10.5 开始,您可以在编译时选择使用 select()poll() 函数。默认情况下,使用的是传统的 select() 函数。如果您想使用 poll() 系统调用,请在编译时添加 CFLAGS=-DLIBCLI_USE_POLL 参数。

安装过程中,libcli.so 库将被安装到 /usr/local/lib 目录。如果您希望更改安装位置,可以编辑 Makefile 文件。

2. 项目使用说明

该项目包含一个名为 clitest 的测试应用程序。运行该应用程序后,您可以通过 telnet 连接到端口 8000。

默认情况下,系统启用了一个用户名和密码组合:

用户名:fred
密码:nerk

输入 help 或按 ? 键可获得帮助信息。

Libcli 支持使用箭头键进行命令行编辑。向上和向下箭头键可以在命令历史中循环切换,而向左和向右箭头键可用于编辑当前命令行。

Libcli 还能够计算出输入命令的最短方法。例如,如果定义了命令 show users | grep foobar,您可以输入 sh us | g foobar 来执行该命令。

在命令行输入 sh? 可获得以 sh 开头的命令列表。

每个 libcli 程序中预定义了一些命令:

  • help
  • quit
  • exit
  • logout
  • history

3. 项目 API 使用文档

在使用您自己的代码之前,请确保在 C 代码中包含 #include <libcli.h>,并在链接时添加 -lcli 参数。

以下是项目中一些重要的 API 函数:

  • cli_init(): 初始化 libcli 所需的内部数据结构。
  • cli_set_banner(banner): 设置欢迎横幅。
  • cli_allow_user(username, password): 添加用户名和密码组合。
  • cli_set_auth_callback(callback): 设置认证回调函数。
  • cli_register_command(parent, command, callback, privilege, mode, help): 注册命令。
  • cli_unregister_command(command): 注销命令。
  • cli_set_context(cli, context): 设置用户定义的上下文。
  • cli_get_context(cli): 获取用户定义的上下文。
  • cli_loop(cli, sock): 与用户在给定套接字上交互。
  • cli_done(): 释放数据结构。

4. 项目安装方式

项目安装方式已在“安装指南”部分进行了说明。您可以通过以下命令进行安装:

$ make
$ make install

请根据您的需要修改 Makefile 文件中的安装路径。

登录后查看全文
热门项目推荐