devbox
从前慢现在也慢
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

开源堡垒机Guacamole二次开发记录之一_guacamole-common

作者：从前慢现在也慢 | 2024-05-07 19:05:27

赞

踩

guacamole-common

简介

项目中需要用到堡垒机功能，调研了一大圈，发现了Apache Guacamole这个开源项目。

Apache Guacamole 是一个无客户端的远程桌面网关，它支持众多标准管理协议，例如 VNC(RFB)，RDP，SSH 等等。该项目是Apache基金会旗下的一个开源项目，也是一个较高标准，并具有广泛应用前景的项目。

当Guacamole被部署在服务器上后，用户通过浏览器即可访问已经开启 VNC(RFB)，RDP，SSH 等远程管理服务的主机，屏蔽用户使用环境差异，跨平台，另外由于Guacamole本身被设计为一种代理工作模型，方便对用户集中授权监控等管理，，也被众多堡垒机项目所集成，例如‘jumpserver’，‘next-terminal’。

Guacamole项目的主页如下：

Apache Guacamole™

Guacamole项目的架构如下图：

包括了guacd、guacamole、前端页面等几个模块。

其中，guacd是由C语言编写，接受并处理guacamole发送来的请求，然后翻译并转换这个请求，动态的调用遵循那些标准管理协议开发的开源客户端，例如FreeRDP，libssh2，LibVNC，代为连接Remote Desktops，最后回传数据给guacamole，guacamole回传数据给web browser。

guacamole是web工程，包含了java后端服务和angular前端页面， 通过servlet或websocket与前端界面交互，通过tcp与guacd交互。同时集成了用户管理、权限验证、数据管理等各种功能。这块的模块组成如下：

 我们项目中有很多自己的业务需求和界面需求，所以，Web这块决定不用开源自带的后端和界面，自己开发。基于guacamole-common和js库进行二次开发。

SpringBoot集成

POM：包含了guacamole-common、guacamole-common-js，以及servlet、websocket等。

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-websocket</artifactId>
  4. </dependency>
  5.  
  6. <dependency>
  7.     <groupId>javax.servlet</groupId>
  8.     <artifactId>servlet-api</artifactId>
  9.     <version>2.5</version>
  10.     <scope>provided</scope>
  11. </dependency>
  12. <dependency>
  13.     <groupId>javax.websocket</groupId>
  14.     <artifactId>javax.websocket-api</artifactId>
  15.     <version>1.0</version>
  16.     <scope>provided</scope>
  17. </dependency>
  18.  
  19. <dependency>
  20.     <groupId>org.apache.guacamole</groupId>
  21.     <artifactId>guacamole-common</artifactId>
  22.     <version>1.5.1</version>
  23. </dependency>
  24. <dependency>
  25.     <groupId>org.apache.guacamole</groupId>
  26.     <artifactId>guacamole-ext</artifactId>
  27.     <version>1.5.1</version>
  28. </dependency>
  29.  
  30. <dependency>
  31.     <groupId>org.apache.guacamole</groupId>
  32.     <artifactId>guacamole-common-js</artifactId>
  33.     <version>1.5.1</version>
  34.     <type>zip</type>
  35.     <scope>runtime</scope>
  36. </dependency>

可以通过servlet或websocket两种方式进行集成，推荐采用websocket方式，性能更好。

配置文件application.yml

  1. server:
  2.   port: 8080
  3.   servlet:
  4.     context-path: /
  5.  
  6. spring:
  7.   servlet:
  8.     multipart:
  9.       enabled: false
  10.       max-file-size: 1024MB
  11.   datasource:
  12.     url: jdbc:mysql://127.0.0.1:3306/guac?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2b8
  13.     username: root
  14.     password: 123456
  15.     driver-class-name: com.mysql.cj.jdbc.Driver
  16.  
  17. mybatis-plus:
  18.   mapper-locations: classpath:mapper/*.xml
  19.  
  20. guacamole:
  21.   ip: 192.168.110.2
  22.   port: 4822

WebSocket方式

从GuacamoleWebSocketTunnelEndpoint中继承类，重载createTunnel方法。

  1. @ServerEndpoint(value = "/webSocket", subprotocols = "guacamole")
  2. @Component
  3. public class WebSocketTunnel extends GuacamoleWebSocketTunnelEndpoint {
  4.     private String uuid;
  5.     private static IDeviceLoginInfoService deviceLoginInfoService;
  6.     private static String guacIp;
  7.     private static Integer guacPort;
  8.     private GuacamoleTunnel guacamoleTunnel;
  9.  
  10.  
  11.     // websocket中，自动注入及绑定配置项必须用这种方式
  12.     @Autowired
  13.     public void setDeviceListenerService(IDeviceLoginInfoService deviceListenerService) {
  14.         WebSocketTunnel.deviceLoginInfoService = deviceListenerService;
  15.     }
  16.  
  17.     @Value("${guacamole.ip}")
  18.     public void setGuacIp(String guacIp) {
  19.         WebSocketTunnel.guacIp = guacIp;
  20.     }
  21.  
  22.     @Value("${guacamole.port}")
  23.     public void setGuacPort(Integer guacPort) {
  24.         WebSocketTunnel.guacPort = guacPort;
  25.     }
  26.  
  27.     @Override
  28.     protected GuacamoleTunnel createTunnel(Session session, EndpointConfig endpointConfig) throws GuacamoleException {
  29.         //从session中获取传入参数
  30.         Map<String, List<String>> map = session.getRequestParameterMap();
  31.  
  32.         DeviceLoginInfoVo loginInfo = null;
  33.  
  34.         String did = map.get("did").get(0);
  35.         tid = map.get("tid").get(0);
  36.         tid = tid.toLowerCase();
  37.  
  38.         // 根据传入参数从数据库中查找连接信息
  39.         loginInfo = deviceLoginInfoService.getDeviceLoginInfo(did, tid);
  40.         if(loginInfo != null) {
  41.             loginInfo.setPort(opsPort);
  42.         }
  43.  
  44.         if(loginInfo != null) {
  45.             //String wid = (map.get("width")==null) ? "1413" : map.get("width").get(0);
  46.             //String hei = (map.get("height")==null) ? "925" : map.get("height").get(0);
  47.             String wid = "1412";
  48.             String hei = "924";
  49.  
  50.             GuacamoleConfiguration configuration = new GuacamoleConfiguration();
  51.  
  52.             configuration.setParameter("hostname", loginInfo.getIp());
  53.             configuration.setParameter("port", loginInfo.getPort().toString());
  54.             configuration.setParameter("username", loginInfo.getUser());
  55.             configuration.setParameter("password", loginInfo.getPassword());
  56.  
  57.             if(tid.equals("ssh")) {
  58.                 configuration.setProtocol("ssh"); // 远程连接协议
  59.                 configuration.setParameter("width", wid);
  60.                 configuration.setParameter("height", hei);
  61.                 configuration.setParameter("color-scheme", "white-black");
  62.                 //configuration.setParameter("terminal-type", "xterm-256color");
  63.                 //configuration.setParameter("locale", "zh_CN.UTF-8");
  64.                 configuration.setParameter("font-name", "Courier New");
  65.                 configuration.setParameter("enable-sftp", "true");
  66.             }
  67.             else if(tid.equals("vnc")){
  68.                 configuration.setProtocol("vnc"); // 远程连接协议
  69.                 configuration.setParameter("width", wid);
  70.                 configuration.setParameter("height", hei);
  71.             }
  72.             else if(tid.equals("rdp")) {
  73.                 configuration.setProtocol("rdp"); // 远程连接协议
  74.                 configuration.setParameter("ignore-cert", "true");
  75.                 if(loginInfo.getDomain() !=null) {
  76.                     configuration.setParameter("domain", loginInfo.getDomain());
  77.                 }
  78.  
  79.                 configuration.setParameter("width", wid);
  80.                 configuration.setParameter("height", hei);
  81.             }
  82.  
  83.             GuacamoleClientInformation information = new GuacamoleClientInformation();
  84.             information.setOptimalScreenHeight(Integer.parseInt(hei));
  85.             information.setOptimalScreenWidth(Integer.parseInt(wid));
  86.  
  87.             GuacamoleSocket socket = new ConfiguredGuacamoleSocket(
  88.                     new InetGuacamoleSocket(guacIp, guacPort),
  89.                     configuration, information
  90.             );
  91.  
  92.             GuacamoleTunnel tunnel = new SimpleGuacamoleTunnel(socket);
  93.  
  94.             guacamoleTunnel = tunnel;
  95.             return tunnel;
  96.         }
  97.  
  98.         return null;
  99.     }
  100. }

Servlet方式

从GuacamoleHTTPTunnelServlet类继承，重载doConnect方法

  1. @WebServlet(urlPatterns = "/tunnel")
  2. public class HttpTunnelServlet extends GuacamoleHTTPTunnelServlet {
  3.     @Resource
  4.     IDeviceLoginInfoService deviceLoginInfoService;
  5.  
  6.     @Value("${guacamole.ip}")
  7.     private String guacIp;
  8.     @Value("${guacamole.port}")
  9.     private Integer guacPort;
  10.  
  11. 	@Override
  12. 	protected GuacamoleTunnel doConnect(HttpServletRequest request) throws GuacamoleException {
  13.         //从HttpServletRequest获取请求参数
  14.         String did = request.getParameter("did");
  15.         String tid = request.getParameter("tid");
  16.         tid = tid.toLowerCase();
  17.  
  18.         //根据参数从数据库中查找连接信息，主机ip、端口、用户名、密码等
  19.         DeviceLoginInfoVo loginInfo = deviceLoginInfoService.getDeviceLoginInfo(did, tid);
  20.  
  21.         if(loginInfo != null) {
  22.             GuacamoleConfiguration configuration = new GuacamoleConfiguration();
  23.  
  24.             configuration.setParameter("hostname", loginInfo.getIp());
  25.             configuration.setParameter("port", loginInfo.getPort().toString());
  26.             configuration.setParameter("username", loginInfo.getUser());
  27.             configuration.setParameter("password", loginInfo.getPassword());
  28.             if(tid.equals("ssh")) {
  29.                 configuration.setProtocol("ssh"); // 远程连接协议
  30.             }
  31.             else if(tid.equals("vnc")){
  32.                 configuration.setProtocol("vnc"); // 远程连接协议
  33.             }
  34.             else if(tid.equals("rdp")) {
  35.                 configuration.setProtocol("rdp"); // 远程连接协议
  36.                 configuration.setParameter("ignore-cert", "true");
  37.                 if(loginInfo.getDomain() != null) {
  38.                     configuration.setParameter("domain", loginInfo.getDomain());
  39.                 }
  40.                 configuration.setParameter("width", "1024");
  41.                 configuration.setParameter("height", "768");
  42.             }
  43.  
  44.             GuacamoleSocket socket = new ConfiguredGuacamoleSocket(
  45.                     new InetGuacamoleSocket(guacIp, guacPort),
  46.                     configuration
  47.             );
  48.  
  49.             GuacamoleTunnel tunnel = new SimpleGuacamoleTunnel(socket);
  50.  
  51.             return tunnel;
  52.         }
  53.  
  54.         return null;
  55. 	}
  56. }

前端页面

我用的是最基本的html+js

  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <link rel="stylesheet" type="text/css" href="guacamole.css"/>
  6.     <title>guac</title>
  7.     <style>
  8.  
  9.     </style>
  10. </head>
  11. <body>
  12. <div id="mainapp">
  13.     <!-- Display -->
  14.     <div id="display"></div>
  15. </div>
  16.  
  17. <!-- Guacamole JavaScript API -->
  18. <script type="text/javascript" src="guacamole-common-js/all.js"></script>
  19. <script type="text/javascript">
  20.     function getUrlParam(name) {
  21.         var reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)");
  22.         var r = window.location.search.substr(1).match(reg);
  23.         if(r != null) {
  24.             return decodeURI(r[2]);
  25.         }
  26.  
  27.         return null;
  28.     }
  29.  
  30.     var user = getUrlParam('user');
  31.     var devid = getUrlParam('did');
  32.     var typeid= getUrlParam('tid');
  33.     // var width = getUrlParam('width');
  34.     // var height = getUrlParam('height');
  35.  
  36.     // Get display div from document
  37.     var display = document.getElementById("display");
  38.  
  39.     var uuid;
  40.     var tunnel = new Guacamole.ChainedTunnel(new Guacamole.WebSocketTunnel("webSocket"));
  41.     var guac = new Guacamole.Client(tunnel);
  42.  
  43.     // Add client to display div
  44.     display.appendChild(guac.getDisplay().getElement());
  45.  
  46.     tunnel.onuuid = function(id) {
  47.         uuid = id;
  48.     }
  49.  
  50.     // Connect
  51.     guac.connect('did='+devid+'&tid='+typeid+'&user='+user);
  52.  
  53.     // Disconnect on close
  54.     window.onunload = function() {
  55.         guac.disconnect();
  56.     }
  57.  
  58.     // Mouse
  59.     var mouse = new Guacamole.Mouse(guac.getDisplay().getElement());
  60.  
  61.     mouse.onmousedown =
  62.         mouse.onmousemove = function(mouseState) {
  63.             guac.sendMouseState(mouseState);
  64.         };
  65.  
  66.     mouse.onmouseup = function(mouseState) {
  67.         vueapp.showfile = false;
  68.         guac.sendMouseState(mouseState);
  69.     };
  70.  
  71.     // Keyboard
  72.     var keyboard = new Guacamole.Keyboard(document);
  73.  
  74.     keyboard.onkeydown = function (keysym) {
  75.         guac.sendKeyEvent(1, keysym);
  76.     };
  77.  
  78.     keyboard.onkeyup = function (keysym) {
  79.         guac.sendKeyEvent(0, keysym);
  80.     };
  81.  
  82.     function setWin() {
  83.         let width = window.document.body.clientWidth;
  84.         let height = window.document.body.clientHeight;
  85.         guac.sendSize(1412, 924);
  86.         scaleWin();
  87.     }
  88.  
  89.     function handleMouseEvent(event) {
  90.         // Do not attempt to handle mouse state changes if the client
  91.         // or display are not yet available
  92.         if(!guac || !guac.getDisplay())
  93.             return;
  94.  
  95.         event.stopPropagation();
  96.         event.preventDefault();
  97.         // Send mouse state, show cursor if necessary
  98.         guac.getDisplay().showCursor(true);
  99.     };
  100.  
  101.     // Forward all mouse interaction over Guacamole connection
  102.     mouse.onEach(['mousemove'], handleMouseEvent);
  103.     // Hide software cursor when mouse leaves display
  104.     mouse.on('mouseout', function hideCursor() {
  105.         guac.getDisplay().showCursor(false);
  106.         display.style.cursor = 'initial';
  107.     });
  108.  
  109.     guac.getDisplay().getElement().addEventListener('mouseenter', function (e) {
  110.         display.style.cursor = 'none';
  111.     });
  112. </script>
  113. </body>
  114. </html>

将页面放在Springboot项目的resource下的static下，启动程序，通过地址

http://ip:8080?did=1&tid=ssh访问，可以打开远程桌面。

可以看出guacamole-common和guacamole-common-js已经做了很好的封装，对于SSH、VNC、RDP这几种远程方式，可以很简单的实现。

接下来，SFTP的实现较为复杂，需要对SFTP上传下载的流程及guacamole封装的协议有较好的了解，才能实现。另外对于录屏及录屏的播放，因为我们的项目中需要把guac和java后端分开两台服务器部署，所以也要有点工作要做。这两部分内容见下一篇博文。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/从前慢现在也慢/article/detail/550720
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号