Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add draft release notes for first RC of 1.6.0. #156

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
276 changes: 276 additions & 0 deletions _releases/1.6.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,276 @@
---

released: false
title: 1.6.0
date: 2024-11-20 15:18:55 -0800
summary: >
TODO...

artifact-url: "https://dist.apache.org/repos/dist/dev/{}"
checksum-url: "https://dist.apache.org/repos/dist/dev/{}"
download-path: "guacamole/1.6.0-RC1/"
checksum-suffixes:
"PGP" : ".asc"
"SHA-256" : ".sha256"

source-dist:
- "source/guacamole-client-1.6.0.tar.gz"
- "source/guacamole-server-1.6.0.tar.gz"

binary-dist:
- "binary/guacamole-1.6.0.war"
- "binary/guacamole-auth-duo-1.6.0.tar.gz"
- "binary/guacamole-auth-header-1.6.0.tar.gz"
- "binary/guacamole-auth-jdbc-1.6.0.tar.gz"
- "binary/guacamole-auth-json-1.6.0.tar.gz"
- "binary/guacamole-auth-ldap-1.6.0.tar.gz"
- "binary/guacamole-auth-quickconnect-1.6.0.tar.gz"
- "binary/guacamole-auth-sso-1.6.0.tar.gz"
- "binary/guacamole-auth-totp-1.6.0.tar.gz"
- "binary/guacamole-history-recording-storage-1.6.0.tar.gz"
- "binary/guacamole-vault-1.6.0.tar.gz"

documentation:
"Manual" : "/doc/1.6.0/gug"
"guacamole-common" : "/doc/1.6.0/guacamole-common"
"guacamole-common-js" : "/doc/1.6.0/guacamole-common-js"
"guacamole-ext" : "/doc/1.6.0/guacamole-ext"
"libguac" : "/doc/1.6.0/libguac"
"libguac-terminal" : "/doc/1.6.0/libguac-terminal"

---

The 1.6.0 release (PLACEHOLDER FOR SUMMARY OF HIGHLIGHTS). For a full list of
all changes in this release, please see the [changelog](#changelog) below.

**The 1.6.0 release is compatible with older 1.x components.** You should
upgrade older components to 1.6.0 when possible, however things should continue
to work correctly in the interim:

* Extensions written for older 1.x releases can be used by 1.6.0.
* Components written for the version of the Guacamole protocol used by older
1.x releases can be used with components of the 1.6.0 release.

Regardless of inter-component compatibility, **there are changes in 1.6.0 which
may affect downstream users of Guacamole's APIs**. Please see the [deprecation
/ compatibility notes](#deprecation--compatibility-notes) section for more
information.

Highlights
----------

### Improved rendering performance

TODO

### Improved containerized deployment options

TODO

### Dedicated audit permission

TODO

### Points of interest in session recordings

TODO

### Batch import of connections from CSV

TODO

### Configurable case sensitivity

TODO

### Complex access restrictions

TODO

### Migration to Duo WebSDK v4

TODO, also requires compat note

### Hidden clipboard contents

TODO

### Support for FreeRDP 3.x

TODO

Deprecation / Compatibility notes
---------------------------------

Each 1.x release of Apache Guacamole should be compatible with components of
older 1.x releases. This compatibility is intended at the Guacamole protocol
level and at the extension level, but not necessarily at the API level. This
means:

* Extensions from older 1.x releases should still work in binary form, but may
need code changes before their source will build against a newer version of
guacamole-ext.
* Software which uses the Guacamole protocol of an older 1.x release should
still work.
* Software which uses libguac from an older 1.x release should still work by
continuing to use the libguac from that release, as newer versions of
libguac may not be API/ABI compatible. In the case of third-party protocol
support plugins for guacd, this means that the guacd from that release must
also be used. Compatibility with respect to libguac is represented by the
[soname](https://en.wikipedia.org/wiki/Soname).
* You should update to newer versions where applicable and when possible.

As of 1.6.0, the following changes have been made which affect compatibility
with past releases:

### TBD

(Placeholder)

* Placeholder...

Changelog
---------

### User interface / platform

* Add the ability to specify separate permissions for "History" and "Active sessions" tabs ([GUACAMOLE-538](https://issues.apache.org/jira/browse/GUACAMOLE-538))
* Support batch import of connections from CSV ([GUACAMOLE-926](https://issues.apache.org/jira/browse/GUACAMOLE-926))
* Parameter Token $GUAC_CONNEXION ([GUACAMOLE-1177](https://issues.apache.org/jira/browse/GUACAMOLE-1177))
* Provide audit log for system modifications ([GUACAMOLE-1224](https://issues.apache.org/jira/browse/GUACAMOLE-1224))
* Make usernames case insensitive in DB ([GUACAMOLE-1239](https://issues.apache.org/jira/browse/GUACAMOLE-1239))
* Provide chunked file upload mechanism ([GUACAMOLE-1320](https://issues.apache.org/jira/browse/GUACAMOLE-1320))
* Show Status of userGroup ([GUACAMOLE-1479](https://issues.apache.org/jira/browse/GUACAMOLE-1479))
* Support for true fullscreen mode and keyboard lock ([GUACAMOLE-1525](https://issues.apache.org/jira/browse/GUACAMOLE-1525))
* Allow branding/customization of the section headers on the user home page ([GUACAMOLE-1584](https://issues.apache.org/jira/browse/GUACAMOLE-1584))
* Add support for specifying VNC "encodings" parameter in webapp UI ([GUACAMOLE-1642](https://issues.apache.org/jira/browse/GUACAMOLE-1642))
* Automatically clear view if session expires in background ([GUACAMOLE-1744](https://issues.apache.org/jira/browse/GUACAMOLE-1744))
* Base64 encoding of image/binary data results in excessive syscalls that can degrade performance ([GUACAMOLE-1776](https://issues.apache.org/jira/browse/GUACAMOLE-1776))
* Update session recording playback progress during large frame gaps ([GUACAMOLE-1803](https://issues.apache.org/jira/browse/GUACAMOLE-1803))
* Enable viewing / searching of key events in session recording playback ([GUACAMOLE-1820](https://issues.apache.org/jira/browse/GUACAMOLE-1820))
* Improvements to the "Recent connections" section ([GUACAMOLE-1866](https://issues.apache.org/jira/browse/GUACAMOLE-1866))
* History Recording Player should indicate points of interest ([GUACAMOLE-1876](https://issues.apache.org/jira/browse/GUACAMOLE-1876))
* Enhance client custom field functionality ([GUACAMOLE-1904](https://issues.apache.org/jira/browse/GUACAMOLE-1904))
* Provide notification, jump-to-top of page for a clone operation ([GUACAMOLE-1916](https://issues.apache.org/jira/browse/GUACAMOLE-1916))

### Docker images

* Installing Guacamole with Docker improvements ([GUACAMOLE-374](https://issues.apache.org/jira/browse/GUACAMOLE-374))
* Provide pre-built images for ARM CPUs ([GUACAMOLE-1374](https://issues.apache.org/jira/browse/GUACAMOLE-1374))
* Docker start script missing options ([GUACAMOLE-1733](https://issues.apache.org/jira/browse/GUACAMOLE-1733))
* Ensure clipboard contents are visible/accessible in Guacamole only when desired ([GUACAMOLE-1740](https://issues.apache.org/jira/browse/GUACAMOLE-1740))
* {:.bug} Unable to login on build from main branch ([GUACAMOLE-1978](https://issues.apache.org/jira/browse/GUACAMOLE-1978))

### Authentication, integration, and storage

* Ensure GUAC_DATE/GUAC_TIME tokens match connection startDate ([GUACAMOLE-61](https://issues.apache.org/jira/browse/GUACAMOLE-61))
* Add Proxy Hostname and Port to LDAP Extension ([GUACAMOLE-577](https://issues.apache.org/jira/browse/GUACAMOLE-577))
* Add support for smart card authentication ([GUACAMOLE-839](https://issues.apache.org/jira/browse/GUACAMOLE-839))
* Enforce rate limit on authentication attempts ([GUACAMOLE-990](https://issues.apache.org/jira/browse/GUACAMOLE-990))
* Specify login-time fixed to days & configureable for groups ([GUACAMOLE-1020](https://issues.apache.org/jira/browse/GUACAMOLE-1020))
* Randomize generation of TOTP key until enrollment is confirmed ([GUACAMOLE-1068](https://issues.apache.org/jira/browse/GUACAMOLE-1068))
* Allow TOTP to be disabled by group membership ([GUACAMOLE-1219](https://issues.apache.org/jira/browse/GUACAMOLE-1219))
* Update guacamole-auth-duo to "Duo Web v4 SDK" ([GUACAMOLE-1289](https://issues.apache.org/jira/browse/GUACAMOLE-1289))
* SAML module should be able to encrypt and sign requests ([GUACAMOLE-1372](https://issues.apache.org/jira/browse/GUACAMOLE-1372))
* Allow LDAP extension to configure TLS level ([GUACAMOLE-1488](https://issues.apache.org/jira/browse/GUACAMOLE-1488))
* Clarify TOTP reset/status logic ([GUACAMOLE-1550](https://issues.apache.org/jira/browse/GUACAMOLE-1550))
* Allow JDBC Auth Extensions to track history for external connections ([GUACAMOLE-1616](https://issues.apache.org/jira/browse/GUACAMOLE-1616))
* Allow extraction of "domain" token from vault extensions ([GUACAMOLE-1623](https://issues.apache.org/jira/browse/GUACAMOLE-1623))
* Enable more granular vault associations ([GUACAMOLE-1629](https://issues.apache.org/jira/browse/GUACAMOLE-1629))
* Allow use of KSM one-time tokens in guacamole-vault-ksm extension ([GUACAMOLE-1643](https://issues.apache.org/jira/browse/GUACAMOLE-1643))
* Allow per-user KSM Vault configurations ([GUACAMOLE-1656](https://issues.apache.org/jira/browse/GUACAMOLE-1656))
* KSM vault extension should allow searching records by domain ([GUACAMOLE-1661](https://issues.apache.org/jira/browse/GUACAMOLE-1661))
* Allow user to configure Keeper Secrets Manager call frequency ([GUACAMOLE-1722](https://issues.apache.org/jira/browse/GUACAMOLE-1722))
* Enforce user access windows even when already logged in ([GUACAMOLE-1723](https://issues.apache.org/jira/browse/GUACAMOLE-1723))
* Add SSO providers list to UI at most once ([GUACAMOLE-1757](https://issues.apache.org/jira/browse/GUACAMOLE-1757))
* TOTP and SAML auth cannot be used together ([GUACAMOLE-1780](https://issues.apache.org/jira/browse/GUACAMOLE-1780))
* {:.bug} KSM Vault extension doesn't support private key from "PAM User" record type ([GUACAMOLE-1795](https://issues.apache.org/jira/browse/GUACAMOLE-1795))
* OIDC JWT claims as user token ([GUACAMOLE-1844](https://issues.apache.org/jira/browse/GUACAMOLE-1844))
* Allow MFA to be bypassed or enforced based on client IP ([GUACAMOLE-1855](https://issues.apache.org/jira/browse/GUACAMOLE-1855))
* ${GUAC_USERNAME} name become domainname\username multiple LDAPS ([GUACAMOLE-1881](https://issues.apache.org/jira/browse/GUACAMOLE-1881))
* Disable autofill on TOTP verification code field ([GUACAMOLE-1946](https://issues.apache.org/jira/browse/GUACAMOLE-1946))
* Provide a comprehensive error message for input exceeding database column ([GUACAMOLE-1948](https://issues.apache.org/jira/browse/GUACAMOLE-1948))

### Protocol support / guacd

* Allow selection of whole words by double-clicking ([GUACAMOLE-192](https://issues.apache.org/jira/browse/GUACAMOLE-192))
* Add support for RemoteFX ([GUACAMOLE-377](https://issues.apache.org/jira/browse/GUACAMOLE-377))
* Allow specifying connection timeout ([GUACAMOLE-600](https://issues.apache.org/jira/browse/GUACAMOLE-600))
* Add support for FreeRDP 3.0.0 ([GUACAMOLE-1026](https://issues.apache.org/jira/browse/GUACAMOLE-1026))
* {:.bug} Open a not published RemoteApp isn’t blocked ([GUACAMOLE-1084](https://issues.apache.org/jira/browse/GUACAMOLE-1084))
* {:.bug} Add support for right modifier keys to SSH/Telnet ([GUACAMOLE-1113](https://issues.apache.org/jira/browse/GUACAMOLE-1113))
* Add auto resize to VNC sessions ([GUACAMOLE-1196](https://issues.apache.org/jira/browse/GUACAMOLE-1196))
* RemoteApp windows become inaccessible after being minimized ([GUACAMOLE-1231](https://issues.apache.org/jira/browse/GUACAMOLE-1231))
* {:.bug} Lines of file gets broken when navigating back and forth using a text editor ([GUACAMOLE-1256](https://issues.apache.org/jira/browse/GUACAMOLE-1256))
* Add option to the vnc protocol to disable remote input ([GUACAMOLE-1267](https://issues.apache.org/jira/browse/GUACAMOLE-1267))
* Add support for SSH certificates ([GUACAMOLE-1290](https://issues.apache.org/jira/browse/GUACAMOLE-1290))
* Add parameter for specifying known RDP server certificate/fingerprint ([GUACAMOLE-1332](https://issues.apache.org/jira/browse/GUACAMOLE-1332))
* {:.bug} "AltGr" received as "Alt" if remote keyboard layout lacks "AltGr" ([GUACAMOLE-1473](https://issues.apache.org/jira/browse/GUACAMOLE-1473))
* {:.bug} SSH Extra line breaks occur when copying an excessively long single line of text ([GUACAMOLE-1586](https://issues.apache.org/jira/browse/GUACAMOLE-1586))
* Add small margins to SSH sessions ([GUACAMOLE-1622](https://issues.apache.org/jira/browse/GUACAMOLE-1622))
* {:.bug} [SSH] When multiple lines of text are selected on the page, the format of the copied text is abnormal ([GUACAMOLE-1632](https://issues.apache.org/jira/browse/GUACAMOLE-1632))
* Add terminal support for alternate screen buffer ([GUACAMOLE-1633](https://issues.apache.org/jira/browse/GUACAMOLE-1633))
* {:.bug} SFTP+VNC broken when built with OpenSSL versions >= 1.1.0 ([GUACAMOLE-1652](https://issues.apache.org/jira/browse/GUACAMOLE-1652))
* Normalize clipboard support for SSH connections ([GUACAMOLE-1682](https://issues.apache.org/jira/browse/GUACAMOLE-1682))
* extend wol-intelligence ([GUACAMOLE-1686](https://issues.apache.org/jira/browse/GUACAMOLE-1686))
* {:.bug} Japanese characters display garbled in terminal when using guacd docker image ([GUACAMOLE-1726](https://issues.apache.org/jira/browse/GUACAMOLE-1726))
* vnc connect add Quality and Compression level params ([GUACAMOLE-1760](https://issues.apache.org/jira/browse/GUACAMOLE-1760))
* Terminal protocols should support mac-style cmd+v paste shortcut ([GUACAMOLE-1804](https://issues.apache.org/jira/browse/GUACAMOLE-1804))
* Ignore Ctrl+Shift+C within terminal emulator ([GUACAMOLE-1805](https://issues.apache.org/jira/browse/GUACAMOLE-1805))
* Allow writing recordings to existing files ([GUACAMOLE-1931](https://issues.apache.org/jira/browse/GUACAMOLE-1931))
* {:.bug} rdp-connect failed when microphone input is enabled ([GUACAMOLE-1940](https://issues.apache.org/jira/browse/GUACAMOLE-1940))
* {:.bug} SSH Offset between selected text and cursor position ([GUACAMOLE-1944](https://issues.apache.org/jira/browse/GUACAMOLE-1944))
* {:.bug} Multiple wheel events per mouse wheel tick ([GUACAMOLE-1967](https://issues.apache.org/jira/browse/GUACAMOLE-1967))
* {:.bug} Issue with dynamic screen resize (freerdp >= 3.8.0) ([GUACAMOLE-1997](https://issues.apache.org/jira/browse/GUACAMOLE-1997))

### Internationalization

* {:.bug} Japanese keyboard layout for RDP incorrect ([GUACAMOLE-520](https://issues.apache.org/jira/browse/GUACAMOLE-520))
* Add support for Canadian french keyboard layout ([GUACAMOLE-1312](https://issues.apache.org/jira/browse/GUACAMOLE-1312))
* Update French translations ([GUACAMOLE-1611](https://issues.apache.org/jira/browse/GUACAMOLE-1611))
* Fix some typos in italian translation and improve it ([GUACAMOLE-1612](https://issues.apache.org/jira/browse/GUACAMOLE-1612))
* Updated czech translation ([GUACAMOLE-1664](https://issues.apache.org/jira/browse/GUACAMOLE-1664))
* Updated german translation ([GUACAMOLE-1692](https://issues.apache.org/jira/browse/GUACAMOLE-1692))
* Add Czech keyboard layout ([GUACAMOLE-1708](https://issues.apache.org/jira/browse/GUACAMOLE-1708))
* Polish translation ([GUACAMOLE-1730](https://issues.apache.org/jira/browse/GUACAMOLE-1730))
* Updated czech translation ([GUACAMOLE-1758](https://issues.apache.org/jira/browse/GUACAMOLE-1758))
* Add Romanian keymap to RDP protocol ([GUACAMOLE-1770](https://issues.apache.org/jira/browse/GUACAMOLE-1770))
* Add Portuguese keymap to RDP protocol ([GUACAMOLE-1771](https://issues.apache.org/jira/browse/GUACAMOLE-1771))
* Update the Simplified Chinese translation ([GUACAMOLE-1778](https://issues.apache.org/jira/browse/GUACAMOLE-1778))
* Update the Simplified Chinese translation for totp auth extension ([GUACAMOLE-1781](https://issues.apache.org/jira/browse/GUACAMOLE-1781))
* Updated czech translation ([GUACAMOLE-1792](https://issues.apache.org/jira/browse/GUACAMOLE-1792))
* {:.bug} Mac Firefox repeats composed characters ([GUACAMOLE-1810](https://issues.apache.org/jira/browse/GUACAMOLE-1810))

### Documentation

* Docker instructions shall stop using --link to link containers ([GUACAMOLE-531](https://issues.apache.org/jira/browse/GUACAMOLE-531))
* Add missing WEBAPP_CONTEXT variable in docker setup documentation ([GUACAMOLE-1680](https://issues.apache.org/jira/browse/GUACAMOLE-1680))
* Document RemoteIPValve to cover IPv4 and IPv6 ([GUACAMOLE-1861](https://issues.apache.org/jira/browse/GUACAMOLE-1861))

### General housekeeping and cleanup

* Provide GuacamoleProperty List Implementations ([GUACAMOLE-1006](https://issues.apache.org/jira/browse/GUACAMOLE-1006))
* Expose client state enum values ([GUACAMOLE-1402](https://issues.apache.org/jira/browse/GUACAMOLE-1402))
* Guacamole manual: Makefile: "find" uses non-POSIX arguments ([GUACAMOLE-1501](https://issues.apache.org/jira/browse/GUACAMOLE-1501))
* {:.bug} Phantomjs build issues on ubuntu 22.04 ([GUACAMOLE-1614](https://issues.apache.org/jira/browse/GUACAMOLE-1614))
* Remove usage of AccessController ([GUACAMOLE-1716](https://issues.apache.org/jira/browse/GUACAMOLE-1716))
* {:.bug} Correct autoconf issues that result in odd build results ([GUACAMOLE-1719](https://issues.apache.org/jira/browse/GUACAMOLE-1719))
* Stop storing unnecessary auth response data in local storage ([GUACAMOLE-1721](https://issues.apache.org/jira/browse/GUACAMOLE-1721))
* {:.bug} Projects outside scope of 1.5.0 fail to build following merge of version number bump ([GUACAMOLE-1731](https://issues.apache.org/jira/browse/GUACAMOLE-1731))
* CI in Github Actions ([GUACAMOLE-1754](https://issues.apache.org/jira/browse/GUACAMOLE-1754))
* {:.bug} Projects outside scope of 1.5.1 fail to build following merge of version number bump ([GUACAMOLE-1767](https://issues.apache.org/jira/browse/GUACAMOLE-1767))
* {:.bug} SQLSERVER_BATCH_SIZE defined twice in SQLServerGuacamoleProperties ([GUACAMOLE-1789](https://issues.apache.org/jira/browse/GUACAMOLE-1789))
* {:.bug} Projects outside scope of 1.5.2 fail to build following merge of version number bump ([GUACAMOLE-1790](https://issues.apache.org/jira/browse/GUACAMOLE-1790))
* {:.bug} Projects outside scope of 1.5.3 fail to build following merge of version number bump ([GUACAMOLE-1829](https://issues.apache.org/jira/browse/GUACAMOLE-1829))
* {:.bug} Merge conflict markers left in guacamole-manual source ([GUACAMOLE-1833](https://issues.apache.org/jira/browse/GUACAMOLE-1833))
* KSM Vault extension should support new PAM Hostname field type ([GUACAMOLE-1868](https://issues.apache.org/jira/browse/GUACAMOLE-1868))
* Align libraries on "Library status" output ([GUACAMOLE-1869](https://issues.apache.org/jira/browse/GUACAMOLE-1869))
* Check return values of WebP API functions ([GUACAMOLE-1875](https://issues.apache.org/jira/browse/GUACAMOLE-1875))
* {:.bug} Projects outside scope of 1.5.4 fail to build following merge of version number bump ([GUACAMOLE-1887](https://issues.apache.org/jira/browse/GUACAMOLE-1887))
* Bump versions for projects outside the 1.5.5 scope ([GUACAMOLE-1915](https://issues.apache.org/jira/browse/GUACAMOLE-1915))
* Add support for FFmpeg 7.0 ([GUACAMOLE-1952](https://issues.apache.org/jira/browse/GUACAMOLE-1952))
* Update dependencies to latest stable and compatible versions ([GUACAMOLE-1956](https://issues.apache.org/jira/browse/GUACAMOLE-1956))
* Bump versions to 1.6.0 ([GUACAMOLE-1980](https://issues.apache.org/jira/browse/GUACAMOLE-1980))
* {:.bug} Compile error in src/protocols/rdp/channels/rail.c ([GUACAMOLE-1982](https://issues.apache.org/jira/browse/GUACAMOLE-1982))
* Upgrade KSM SDK to latest (v16.6.5) ([GUACAMOLE-1984](https://issues.apache.org/jira/browse/GUACAMOLE-1984))

Loading