springboot Guacamole

SpringBoot集成

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.7</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.shell</groupId>
    <artifactId>guacamole</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>guacamole</name>
    <description>guacamole 二次开发</description>
    <properties>
        <java.version>8</java.version>
        <mysql.version>8.3.0</mysql.version>
        <mybatis-plus.version>3.5.5</mybatis-plus.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>

        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>javax.websocket</groupId>
            <artifactId>javax.websocket-api</artifactId>
            <version>1.0</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>org.apache.guacamole</groupId>
            <artifactId>guacamole-common</artifactId>
            <version>1.5.4</version>
        </dependency>
        <dependency>
            <groupId>org.apache.guacamole</groupId>
            <artifactId>guacamole-ext</artifactId>
            <version>1.5.4</version>
        </dependency>

        <dependency>
            <groupId>org.apache.guacamole</groupId>
            <artifactId>guacamole-common-js</artifactId>
            <version>1.5.4</version>
            <type>zip</type>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>${mysql.version}</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <!-- <version>3.0.3</version> -->
            <version>2.0.6</version>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-extension</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-annotation</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

配置文件application.yml

server:
  port: 8080
  servlet:
    context-path: /
 
spring:
  servlet:
    multipart:
      enabled: false
      max-file-size: 1024MB
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/guac?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2b8
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
 
mybatis-plus:
  mapper-locations: classpath:mapper/*.xml
 
guacamole:
  ip: 192.168.110.2
  port: 4822

WebSocket方式

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

@ServerEndpoint(value = "/webSocket", subprotocols = "guacamole")
@Component
public class WebSocketTunnel extends GuacamoleWebSocketTunnelEndpoint {
    private String uuid;
    private static IDeviceLoginInfoService deviceLoginInfoService;
    private static String guacIp;
    private static Integer guacPort;
    private GuacamoleTunnel guacamoleTunnel;
 
 
    // websocket中，自动注入及绑定配置项必须用这种方式
    @Autowired
    public void setDeviceListenerService(IDeviceLoginInfoService deviceListenerService) {
        WebSocketTunnel.deviceLoginInfoService = deviceListenerService;
    }
 
    @Value("${guacamole.ip}")
    public void setGuacIp(String guacIp) {
        WebSocketTunnel.guacIp = guacIp;
    }
 
    @Value("${guacamole.port}")
    public void setGuacPort(Integer guacPort) {
        WebSocketTunnel.guacPort = guacPort;
    }
 
    @Override
    protected GuacamoleTunnel createTunnel(Session session, EndpointConfig endpointConfig) throws GuacamoleException {
        //从session中获取传入参数
        Map<String, List<String>> map = session.getRequestParameterMap();
 
        DeviceLoginInfoVo loginInfo = null;
 
        String did = map.get("did").get(0);
        tid = map.get("tid").get(0);
        tid = tid.toLowerCase();
 
        // 根据传入参数从数据库中查找连接信息
        loginInfo = deviceLoginInfoService.getDeviceLoginInfo(did, tid);
        if(loginInfo != null) {
            loginInfo.setPort(opsPort);
        }
 
        if(loginInfo != null) {
            //String wid = (map.get("width")==null) ? "1413" : map.get("width").get(0);
            //String hei = (map.get("height")==null) ? "925" : map.get("height").get(0);
            String wid = "1412";
            String hei = "924";
 
            GuacamoleConfiguration configuration = new GuacamoleConfiguration();
 
            configuration.setParameter("hostname", loginInfo.getIp());
            configuration.setParameter("port", loginInfo.getPort().toString());
            configuration.setParameter("username", loginInfo.getUser());
            configuration.setParameter("password", loginInfo.getPassword());
 
            if(tid.equals("ssh")) {
                configuration.setProtocol("ssh"); // 远程连接协议
                configuration.setParameter("width", wid);
                configuration.setParameter("height", hei);
                configuration.setParameter("color-scheme", "white-black");
                //configuration.setParameter("terminal-type", "xterm-256color");
                //configuration.setParameter("locale", "zh_CN.UTF-8");
                configuration.setParameter("font-name", "Courier New");
                configuration.setParameter("enable-sftp", "true");
            }
            else if(tid.equals("vnc")){
                configuration.setProtocol("vnc"); // 远程连接协议
                configuration.setParameter("width", wid);
                configuration.setParameter("height", hei);
            }
            else if(tid.equals("rdp")) {
                configuration.setProtocol("rdp"); // 远程连接协议
                configuration.setParameter("ignore-cert", "true");
                if(loginInfo.getDomain() !=null) {
                    configuration.setParameter("domain", loginInfo.getDomain());
                }
 
                configuration.setParameter("width", wid);
                configuration.setParameter("height", hei);
            }
 
            GuacamoleClientInformation information = new GuacamoleClientInformation();
            information.setOptimalScreenHeight(Integer.parseInt(hei));
            information.setOptimalScreenWidth(Integer.parseInt(wid));
 
            GuacamoleSocket socket = new ConfiguredGuacamoleSocket(
                    new InetGuacamoleSocket(guacIp, guacPort),
                    configuration, information
            );
 
            GuacamoleTunnel tunnel = new SimpleGuacamoleTunnel(socket);
 
            guacamoleTunnel = tunnel;
            return tunnel;
        }
 
        return null;
    }
}

前端页面

我用的是最基本的html+js

<!DOCTYPE HTML>
<html>
<head>
    <meta charset="UTF-8">
    <link rel="stylesheet" type="text/css" href="guacamole.css"/>
    <title>guac</title>
    <style>
 
    </style>
</head>
<body>
<div id="mainapp">
    <!-- Display -->
    <div id="display"></div>
</div>
 
<!-- Guacamole JavaScript API -->
<script type="text/javascript" src="guacamole-common-js/all.js"></script>
<script type="text/javascript">
    function getUrlParam(name) {
        var reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)");
        var r = window.location.search.substr(1).match(reg);
        if(r != null) {
            return decodeURI(r[2]);
        }
 
        return null;
    }
 
    var user = getUrlParam('user');
    var devid = getUrlParam('did');
    var typeid= getUrlParam('tid');
    // var width = getUrlParam('width');
    // var height = getUrlParam('height');
 
    // Get display div from document
    var display = document.getElementById("display");
 
    var uuid;
    var tunnel = new Guacamole.ChainedTunnel(new Guacamole.WebSocketTunnel("webSocket"));
    var guac = new Guacamole.Client(tunnel);
 
    // Add client to display div
    display.appendChild(guac.getDisplay().getElement());
 
    tunnel.onuuid = function(id) {
        uuid = id;
    }
 
    // Connect
    guac.connect('did='+devid+'&tid='+typeid+'&user='+user);
 
    // Disconnect on close
    window.onunload = function() {
        guac.disconnect();
    }
 
    // Mouse
    var mouse = new Guacamole.Mouse(guac.getDisplay().getElement());
 
    mouse.onmousedown =
        mouse.onmousemove = function(mouseState) {
            guac.sendMouseState(mouseState);
        };
 
    mouse.onmouseup = function(mouseState) {
        guac.sendMouseState(mouseState);
    };
 
    // Keyboard
    var keyboard = new Guacamole.Keyboard(document);
 
    keyboard.onkeydown = function (keysym) {
        guac.sendKeyEvent(1, keysym);
    };
 
    keyboard.onkeyup = function (keysym) {
        guac.sendKeyEvent(0, keysym);
    };
 
    function setWin() {
        let width = window.document.body.clientWidth;
        let height = window.document.body.clientHeight;
        guac.sendSize(1412, 924);
        scaleWin();
    }
 
    function handleMouseEvent(event) {
        // Do not attempt to handle mouse state changes if the client
        // or display are not yet available
        if(!guac || !guac.getDisplay())
            return;
 
        event.stopPropagation();
        event.preventDefault();
        // Send mouse state, show cursor if necessary
        guac.getDisplay().showCursor(true);
    };
 
    // Forward all mouse interaction over Guacamole connection
    mouse.onEach(['mousemove'], handleMouseEvent);
    // Hide software cursor when mouse leaves display
    mouse.on('mouseout', function hideCursor() {
        guac.getDisplay().showCursor(false);
        display.style.cursor = 'initial';
    });
 
    guac.getDisplay().getElement().addEventListener('mouseenter', function (e) {
        display.style.cursor = 'none';
    });
</script>
</body>
</html>

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

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

Guacamole调用录像功能

GuacamoleConfiguration guacamoleConfig = new GuacamoleConfiguration();
guacamoleConfig.setProtocol("vnc");
guacamoleConfig.setParameter("hostname", vm.getVirtualMachineIp());
guacamoleConfig.setParameter("port", "5901");
guacamoleConfig.setParameter("password", "vncpassword");
 
//校验前端是否开启了录屏
if(request.getParameter("open-recording") != null){
    //添加会话录制--录屏
    guacamoleConfig.setParameter("typescript-path", "/");
    guacamoleConfig.setParameter("create-typescript-path", "true");
    guacamoleConfig.setParameter("typescript-name", "" );
    guacamoleConfig.setParameter("recording-path", "/recording");
    guacamoleConfig.setParameter("create-recording-path", "true");
    guacamoleConfig.setParameter("recording-name", ""+new Date().getTime()+".guac");
}

录像文件文件转化为MP4文件 

docker pull litios/guacenc
docker run -v /extdatas/guacamole/recordings/:/recordings -d -it --name guacenc litios/guacenc

.guac文件转换为.m4v 

docker exec -it guacenc guacenc -f /recordings/20230831124552.guac

将.m4v转换为.mp4 

docker exec -it guacenc ffmpeg -i /recordings/20230831124552.guac.m4v /recordings/20230831124552.guac.mp4

对单一文件进行编码

docker exec -it guacenc guacenc -s 1280x720 -r 20000000 -f /recordings/20230831124552.guac