Compare commits

...
494 Commits
Author SHA1 Message Date
Dave Page 062099ae5b Retry stapler validate in the macOS build and acceptance checks. (#10686)
It looks the notarisation ticket up in Apple's CloudKit, and a dropped
connection there has failed both the arm64 build's verification step,
skipping the rest of a release candidate, and the acceptance test, on
bundles that were notarised and accepted by Gatekeeper.
2026-10-27 00:01:39 +00:00
Dave Page 0e7c33bee2 chore: Sign the versioned OpenSSL, gettext and iconv libraries in the Windows build. (#10684)
FOR treats an item containing a wildcard as a glob against the current
directory and drops it when nothing matches, so libcrypto-*-x64.dll,
libssl-*-x64.dll, libintl-*.dll and libiconv-*.dll never reached the
inner DIR and were shipped unsigned since #10355. Run the loop from the
runtime directory instead, checking each name exists.
2026-10-27 01:46:48 +05:30
Ashesh Vashi 5a082916f8 Collect only the release-candidate build outputs, not the build record.
The assemble job downloaded every artefact of the run, which includes the
'pgadmin-org~pgadmin4~*.dockerbuild' build record that
docker/build-push-action uploads for the container. That artefact is not
stored as a plain zip, so actions/download-artifact fails to extract it,
and because it was downloading everything, the whole step failed after
its retries with 'Artifact download failed after 5 retries' -- while every
real artefact downloaded fine. None of the build record is used here; the
staging tree is assembled only from the pgadmin4-* artefacts. Restrict the
download to pgadmin4-*, which leaves the build record behind.
2026-10-27 00:05:21 +05:30
Ashesh Vashi 0eac05b450 Grant packages: write to the release-candidate container job.
A called workflow's token is capped by the caller's permissions. The
release-candidate workflow sets 'contents: read' at the top level, which
leaves 'packages: none', so when it publishes the container with
publish: true the check-container-build publish-container job's
'packages: write' request exceeded the cap and the workflow was rejected
before starting (startup_failure). Grant packages: write on the container
caller job. The nightly snapshot is unaffected: it builds the container
as a check, with publish-container skipped, so it never requests the
scope.
2026-10-26 22:35:55 +05:30
Ashesh Vashi 7bbbb53e69 Skip the missing-client-file passthrough test on Windows.
Like the equivalent utility_conninfo case, a configured client file that
cannot be found is disabled (NO_CLIENT_FILE) on Windows rather than passed
on as its path; both are unopenable, so the connection still cannot use
another file. fs_short_path() also returns empty for a path that does not
exist on Windows, so the expectation could not be normalised. Run the
passthrough scenario on POSIX only.
2026-10-26 19:33:39 +05:30
Ashesh Vashi eb66e6a347 Make the 9.19 security tests pass on Windows.
The tests added for the 9.19 storage and connection hardening were
written on Linux and failed on Windows, where the behaviour they check
is correct but expressed differently. The production code is unchanged.

- Skip the Backup, Restore and Import/Export descriptor-based
  symlink-race tests on Windows: opening a file with O_NOFOLLOW and
  handing it to the utility as /dev/fd/N is POSIX-only, and the code
  already passes the real path there.
- Compare credential-file paths after fs_short_path()+forward slashes,
  the short (8.3) form libpq is given on Windows; this is the identity
  on POSIX. Covers the --dbname conninfo call sites, get_complete_file_path,
  client-file isolation and the SSH tunnel identity file.
- Normalise the File Manager closest-parent separator to '/'.
- Drop the other inherited credential variable before checking which
  remove_inherited_libpq_credentials() removes, as the runner's own
  environment may hold PGPASSWORD.
- Use forward slashes in the raw hostile --database value, whose
  backslashes libpq would otherwise treat as escapes, and skip the
  'missing configured file passed through' case on Windows, where such
  a file is disabled (NO_CLIENT_FILE) instead.
2026-10-26 19:02:39 +05:30
Ashesh Vashi 36122bc29b Skip the Kerberos require_auth tests where the installed libpq is older than 16.
require_auth needs libpq 16, so pgAdmin only adds it when the installed
libpq is new enough.  These tests mock the connection-parameter libpq
version to exercise that path, but create_connection_string() validates
the connection string, and the injection tests build and parse it, with
the real installed libpq.  On a runner whose libpq is older than 16 that
libpq rejects require_auth, so the scenarios that produce it errored on
macOS and Windows.  Skip a require_auth-producing scenario when the
installed libpq cannot parse it, as the one real-parser scenario in
test_kerberos_conninfo already did.
2026-10-26 17:34:28 +05:30
Kundan 6d035dc4fa Skip the view msql tests that expect DROP VIEW on EPAS. (#10660)
EPAS can change a view's columns with CREATE OR REPLACE VIEW, so pgAdmin
only drops and re-creates the view on PostgreSQL (#5053). The tests
added for #9838 expected DROP VIEW on every server and failed on EPAS.
2026-10-26 17:30:22 +05:30
Ashesh Vashi ea17a4e0ff Install libpq in the Docker env-builder so psycopg's C extension loads.
python:3-alpine now resolves to Python 3.15, whose psycopg[c] wheel links
against the system libpq.  postgresql-dev is removed with build-deps, so
libpq.so.5 was no longer present at runtime and importing psycopg (as the
Sphinx docs build does via config.py) failed with 'no pq wrapper
available', breaking the container build.  Install the runtime libpq
package separately so it survives the build-deps cleanup.
2026-10-26 15:43:59 +05:30
Ashesh Vashi a972ea204e Fix the 9.19 release notes using a math-italic pi where 'py' was meant, which broke the PDF docs build. 2026-10-26 15:43:59 +05:30
Dave Page 2551643aa1 chore: Add pgEdge Starfleet cloud deployment to the 9.19 release notes. 2026-10-26 08:56:33 +00:00
Ashesh Vashi b939b85ecb chore: Bump the version to 9.19.
Update APP_REVISION and APP_VERSION_INT in web/version.py, and the
Helm chart's version and appVersion.
2026-10-26 12:30:38 +05:30
Ashesh Vashi 4581fddd8d chore: Add the 9.19 security release notes and the release date.
One entry per tracking issue (#10645-#10676), with the CVE identifiers
for the 15 vulnerabilities.

Also set the release date to 2026-10-29, and add the upgrade guidance
for the SSH agent, Flask-Security-Too, non-administrator shares and
SERVER_MODE_ALLOWED_SERVICES.
2026-10-26 12:30:38 +05:30
Ashesh Vashi e13b12c492 chore: Add the release notes for the changes since 26a7d92b0 to 9.19. 2026-10-26 12:30:38 +05:30
Dave Page f4b5309267 chore: Add the release notes for 9.19. 2026-10-26 12:30:38 +05:30
Ashesh Vashi 9e985fef5b Updated message catalogs for v9.19 2026-10-25 23:26:24 +05:30
Ashesh Vashi 5ecdcd7201 Document the authentication behaviour changes for 9.19: separate accounts per source, lockout, session invalidation, and the user-management command examples.
Add a shared "Accounts from different authentication sources" section to the
user management docs and link to it from the LDAP, Kerberos, OAuth2 and
Webserver pages. It explains that an account is identified by its username
and its authentication source together, that an external login is never
logged in to an account from another source, and that a password reset acts
only on the internal account. It also describes the account-lockout
behaviour: MAX_LOGIN_ATTEMPTS applies only to internal accounts, pgAdmin
never locks an account from another source, a failed sign-in for a shared
username counts towards the internal account's lockout, and a locked internal
account stops only internal sign-in without disclosing the lock while another
source is configured.

The LDAP page also notes that, with internal and LDAP both enabled, a shared
username is tried against both sources in the configured order, and that
accounts whose usernames differ only in case should not be created when
LDAP_DN_CASE_SENSITIVE is off.

Note on the Change pgAdmin Password page that changing the password, or an
administrator resetting it, signs out the user's other sessions.

Fix the setup.py examples: add-external-user and update-external-user take
the authentication source through --auth-source, not as a positional
argument; update-user and update-external-user do not take a password
positionally; the built-in role is "User", not "Users"; and a user added
without a role gets the "User" role.
2026-10-25 21:44:28 +05:30
Ashesh Vashi f88596f90c Reject a backslash or null byte in a schema, table or column name in Import/Export Data. #10663
A schema, table or column name is wrapped with qtIdent() and interpolated
into psql's \copy command. qtIdent() doubles an embedded double quote but
leaves a backslash untouched, while psql's \copy parser (strtokx) treats a
backslash inside a double-quoted identifier as an escape. A name such as
one ending in a backslash therefore becomes "name\", which psql reads as
an unterminated identifier that runs past its intended end, the same
command-injection class (CWE-78) that the query guard already blocks for
query exports. A null byte can truncate the C string so Python's
validation and psql's parse disagree. The column lists reach the \copy
command's FORCE_* options even for a query export, so they are affected
too.

Reject a backslash or null byte in any of these names outright, as the
query path does; pgAdmin never needs to name an object containing one.
The check inspects the names columns_to_string() would pass to qtIdent()
whatever JSON type they arrive as (a list's items, a dict's keys, or a
bare string iterated character by character), so a column value sent as a
string or object cannot slip a backslash through.
2026-10-25 19:52:48 +05:30
Ashesh Vashi 602c3c165f chore: Update third-party dependencies and fix two feature-test helper issues.
JavaScript: @tanstack/react-query, @tanstack/react-table, dompurify,
lossless-json, rc-dock, react, react-dom, react-dropzone,
react-virtualized-auto-sizer, html-react-parser, zustand,
@mui/x-date-pickers, core-js, webpack, postcss, typescript-eslint,
eslint-plugin-jest, globals, @testing-library/user-event.

The postcss resolution override is raised along with the direct
dependency, so installs actually resolve to 8.5.31.

Python (python_version > '3.9' rows only): Authlib, certifi,
Flask-SocketIO, urllib3 and selenium.

Held back: @tanstack/react-virtual (3.14.13) and marked (18.0.14) break
the Jest suite in later releases, and pickr stays at ~1.9.1 because
1.10.x breaks the production bundle.

Feature tests:
- Backup and Restore clicked their Tools menu item while it was still
  disabled, because the menus are refreshed asynchronously after a
  database gets connected. Wait for the item to be enabled first.
- check_if_element_exists_with_scroll() never terminated when it reached
  the bottom of the tree and the node it looked for was above the visible
  area. Stop scrolling down at that point.
2026-10-25 17:49:29 +05:30
Ashesh Vashi d25a38fe62 Give users added by setup.py the User role when no role is given. #10675
add-user and add-external-user defaulted --role to None, so without
--role or --admin they looked up a role named None and exited with
"Role 'None' does not exists." Default --role to 'User', the role
pgAdmin gives every user it creates itself. --admin still takes
precedence, and an unknown --role still fails.
2026-10-25 16:10:08 +05:30
Ashesh Vashi d92fb68b22 Make the LDAP login scenarios independent of each other and of their order. #10675
The 'LDAP Authentication with Auto Create User' scenario logged in
ldap_user, creating an LDAP account that was never deleted, and the
'without Auto Create User' scenario only passed because that account was
already there; run on its own it failed.

The 'without' scenario now adds the LDAP account it logs in to with
add_user(), which deletes it with the rows the login created when the
test ends, and every auto-create scenario deletes the account its login
created.
2026-10-25 16:10:08 +05:30
Ashesh Vashi 2bca0b3cc9 Show the user just added by setup.py add-external-user. #10675
After adding a user, setup.py looked the new account up for display by
its email together with the auth source. For an external user the email
is not the username, so without --email every user of that auth source
was listed, and with --email nothing was shown at all.

Look the account up by the username it was created with and its auth
source instead, and add tests that run setup.py add-user and
add-external-user against a copy of the test database and check that
only the new account is shown.
2026-10-25 16:10:08 +05:30
Ashesh Vashi 2fc4b1f3d4 Fix logins and user management when an account shares its username or email with one from another source. #10675
- Webserver login and auto-creation looked the account up by username
  alone. An internal account with the same username was found first, so
  the Webserver user was refused, or never created.
- LDAP auto-creation, when LDAP_DN_CASE_SENSITIVE is off, compared the
  stored username with the lower-cased login name, so an LDAP user whose
  username has capitals was not found after their first login, and the
  attempt to create them again failed, so they could not log in. It now
  compares both lower-cased.
- setup.py update-user and update-external-user failed with a KeyError
  unless --role or --admin was given, so an account could not be
  deactivated on its own, as the LDAP documentation describes.

A test also checks that a password reset requested with the email in
another case is sent for the internal account.
2026-10-25 16:10:08 +05:30
Ashesh Vashi c6ef41a951 Refuse sign-in, password change and password reset requests that skip pgAdmin's own checks. #10676
Flask-Security registers views of its own next to pgAdmin's: /login,
/verify, /change, /reset and /reset/<token>. Submitting to them logged a
user in without the failed login count or the lock, checked a signed-in
user's password without limit, changed a password without pgAdmin's
change password permission or re-encrypting the saved server passwords,
and sent or applied a password reset for an account that is not
internal or is locked. pgAdmin does all of these through views of its
own, so a submission to Flask-Security's is now refused with 405
Method Not Allowed. A GET still renders the page, as GET /login renders
pgAdmin's login page, whose form is posted to /authenticate/login. The
refusal is not logged as an error, as anyone can send one.

The test uses server mode only views and is excluded in desktop mode.
2026-10-25 16:01:14 +05:30
Ashesh Vashi 35c9235d17 Count every failed internal login, and lock only internal authentication. #10676
The limit on failed logins (MAX_LOGIN_ATTEMPTS) could be got round, and
its lock reached accounts it does not protect:

- The internal account was looked up by its exact username, while
  Flask-Security matches the email ignoring case, so a username typed in
  another case was neither counted nor checked for the lock. It is now
  looked up as Flask-Security does.
- With LDAP or Webserver authentication also configured, the login form
  always passed validation, so a wrong internal password was never
  counted. It is now counted whenever no source authenticates the user
  and internal authentication was tried.
- A login that posts a password no longer falls back to Kerberos, OAuth2
  or Webserver authentication, which do not check it: with them listed,
  a guess was answered by the Kerberos challenge, or silently logged in
  the user the web server named, without being counted.
- The account is locked on the failed login that reaches the limit, and
  the user is told so, rather than at the next login.
- A login through another source no longer resets the internal
  account's failed logins.

The lock is the internal account's. A locked internal account only stops
internal authentication: the other sources are still tried and only ever
log in an account of their own, so a user of another source with the
same name is not locked out by it. The password is not checked against
the locked account. When another source refuses the user, one neutral
message is shown whatever the password, saying a pgAdmin account may be
locked; with no other source to try, the account locked message is shown
as before. The skip is logged.

The new tests use server mode only features and are excluded in desktop
mode. The Kerberos login test now posts no password, as a Kerberos login
does.
2026-10-25 16:01:14 +05:30
Ashesh Vashi 58c531d831 Act only on the internal account when accounts from other sources share its email or username. #10676
The same email or username may belong to accounts from several auth
sources. Flask-Security looks the account up by email alone, and took
whichever row came first:

- Internal login checked the password against that row, so an internal
  user could not log in when an LDAP or OAuth2 account with the same
  email was found first. Flask-Security's lookup now prefers the internal
  account; ignoring case, it prefers the one matching exactly, then the
  oldest. A missing email or username identifies no account.
- A password reset was sent for whichever account had the email, and a
  reset token for an account from another source was accepted, giving it
  a local password and logging it in. Reset instructions are now sent
  for the internal account, and a token for any other account is
  refused.
- The About box showed the configuration to any user whose email was
  that of an administrator's account, whatever its source. It now checks
  the user's own role.

The test runner excluded every test module whose name started with one
on its desktop mode list, so excluding test_reset_password also excluded
test_reset_password_auth_source. Each entry now excludes only the module
it names, and the server mode only modules are listed.
2026-10-25 16:01:14 +05:30
Ashesh Vashi b39f1a8d79 Give the File Manager save tests an absolute path in desktop mode, where there is no storage directory. #10674
In desktop mode get_storage_directory() returns None and a path is
absolute, so check_access_permission() returns it unchanged. These tests
patch in a storage directory in either mode and passed a path relative
to it, which in desktop mode named a file at the root of the filesystem,
so the save failed. They now pass a path inside the storage directory in
desktop mode, as a desktop user would.
2026-10-25 11:43:20 +05:30
Ashesh Vashi d91a2745f0 Run the shared storage write-target tests fully in server mode, so they pass in desktop mode too. #10650
The tests patched the application's SERVER_MODE setting but not
config.SERVER_MODE, which get_locale() reads. In desktop mode the refusal
message's gettext() then took the desktop branch and read
current_user.is_authenticated from the stand-in user, which has no such
attribute, so the "non-admin cannot write" scenario failed. Patch
config.SERVER_MODE as well in the three tests that use this setup.
2026-10-25 11:43:20 +05:30
Ashesh Vashi ad6c028cff Make the File Manager and storage-path tools act on the path that was checked. #10674
In server mode, check_access_permission() validated a path into the
user's storage directory, but several callers then acted on a path built
differently, so the path checked and the path used could name different
files:

- Opening a file in the Query Tool, saving a file, the Google client
  secret and, on Windows, Import/Export Data, Backup and Restore joined
  the path to the storage directory after stripping leading separators,
  so a path checked as inside storage could name any file the pgAdmin
  account can read, or on Windows write outside it.
- Listing a folder decoded the path again after the check, so a folder
  named like an encoded ".." listed any directory on the host.
- Download, delete, rename and the file-exists check appended the path
  to the storage directory without a separator, so where one user's
  storage directory name was a prefix of another's, that user's files
  could be read, deleted or moved; download also checked the path
  appended to itself.
- Creating a folder checked the parent rather than the folder created,
  and upload wrote to a path that was not checked.

check_access_permission() now returns the absolute path it checked, and
every caller acts on that path. Folder paths are decoded once, rename
checks the new name where it is created, and download returns a 404
without the server path for a missing file.

In server mode on POSIX, download, delete, rename and file loads now
open files relative to directories opened from the storage directory
without following symbolic links, as upload and save already did, so a
parent directory swapped for a symbolic link after the check is refused.
The walk follows the path as written: a ".." goes back up past a
directory the walk opened, rather than being collapsed in the text to a
different file from the one the check resolved. It keeps open only the
directories a later ".." can still go back up to, so a path holds at
most two more file descriptors than it has ".." segments, and working
out which to keep takes time linear in the length of the path.

Also:
- The storage directory itself can no longer be deleted.
- In desktop mode, a download refuses a FIFO or other non-regular file
  instead of blocking on it; symbolic links are still followed there.
- A symbolic link refusal is recognised as ELOOP, or EMLINK only where
  O_NOFOLLOW uses it.
- The File Manager sends the selected storage when checking whether a
  file exists, so the overwrite prompt sees files in a shared storage.
- get_closest_parent() tested whether the storage directory existed
  rather than the remembered folder; it now finds the closest existing
  folder inside storage.
- A refused or failed download now shows the server's message.
- check_file_for_bom_and_binary() reports a read error in its result.
2026-10-25 11:03:55 +05:30
Ashesh Vashi 269e32d5ee Ensure Kerberos and internal authentication only log in the account of the user they authenticated. #10675
The same username may exist under several auth sources. Kerberos uses
the shared login(), which looked the account up by username alone, so a
Kerberos principal matching an internal account's username was logged in
as that internal account, including the initial administrator. login()
now looks the account up by the authenticated username and the source
that authenticated it.

form.user is no longer used by any source but internal. Flask-Security's
validation, run for internal authentication, sets it to the account whose
email was typed, whether or not its password matched. With internal
authentication listed first, a Kerberos user could type another Kerberos
user's principal and be logged in as them, and an LDAP user could do the
same with an LDAP account whose email is their username. Internal login
logs in form.user, whose password was verified, only if it is an
internal account, and otherwise nothing.

The LDAP + Internal login test relied on an LDAP bind that accepted the
internal test account's credentials logging in that internal account,
which is the behaviour fixed here. LDAP now refuses those credentials in
that scenario, and new scenarios check that an LDAP login whose username
matches an internal account is not logged in as it, with LDAP or
internal authentication tried first. A further test logs in through the
login endpoint as a Kerberos user who types another Kerberos user's
principal. The LDAP documentation's add-external-user example passed the
source as an argument; it is given with --auth-source.
2026-10-24 19:36:14 +05:30
Dave Page 7378060e5c Ensure LDAP authentication only logs in LDAP-sourced accounts. #10675
LDAPAuthentication.login() looked up the user to log in by username
alone, or accepted the form.user set by Flask-Security's internal
validation, without checking its auth source. Because the same username
may exist under several auth sources, an LDAP user whose username matched
an Internal account (such as the initial administrator created at setup)
was logged in as that Internal account, with its roles.

Only use form.user if it is LDAP-sourced, and restrict the fallback
lookups to auth_source=LDAP, matching the existing guard in Webserver
authentication.

Document that the initial administrator is always an Internal account,
and recommend deactivating it in favour of an LDAP administrator when
using LDAP authentication only.

Reported-by: Yves Soete of Blacksight LLC
2026-10-24 19:36:14 +05:30
Kundan d52fe4740e Stop SSH tunnels using the pgAdmin service account's own SSH identity. #10662
sshtunnel was given neither host_pkey_directories nor ssh_config_file, so it
always loaded the unencrypted private keys in ~/.ssh of the account pgAdmin
runs as, and read that account's ~/.ssh/config (IdentityFile, User, HostName,
ProxyCommand) for the tunnel host. In server mode any user could therefore
configure a tunnel to a host reachable by that account, with no credentials
or an identity file that does not exist in their storage, and authenticate
with the service account's key. The ssh-agent of that account could also be
used.

In server mode the tunnel no longer reads those keys or that configuration,
and does not use the agent. An identity file that cannot be found in the
user's storage is reported instead of silently falling back to ~/.ssh.
Desktop mode is unchanged.

Compatibility: in server mode, SSH tunnels that relied on the service
account's own key, ~/.ssh/config or ssh-agent will stop working; the
identity file or password must be configured on the server instead.
2026-10-24 19:36:14 +05:30
hiteshjambhale 67eab1ba89 Invalidate a user's other sessions when their password is changed. #10646
Rotate fs_uniquifier on a password change (self-service and admin reset), so
every other session of that user is logged out. The changing session is
re-logged in, and its database connections are kept.

Re-encrypt saved passwords, including shared-server ones, under the new key.
Passwords that can't be decrypted are cleared, and the user is told. If
re-encryption fails, the sessions are still revoked and all saved passwords
are cleared rather than returning an error.

Reported-by: Zohaib
2026-10-24 19:36:13 +05:30
Kundan 9e95d9a721 Reject SHARED_STORAGE paths in the utility binary-path guard. #10656
does_utility_exist() and /misc/validate_binary_path only rejected a
binary path under STORAGE_DIR, so a user could point the binary path of
a server type at a SHARED_STORAGE directory that ordinary users can
write to, and have pgAdmin execute whatever file was placed there
(CWE-426).

The check is now made by is_reserved_storage_path(), shared by both call
sites and extended to every SHARED_STORAGE entry. It expands $DIR and
collapses '..' before resolving symlinks, so it judges the directory the
utilities actually run from, compares directories with samefile() so
that a different spelling on a case-insensitive filesystem cannot get
past it, and refuses a path containing a NUL. An empty STORAGE_DIR is
treated as unreserved instead of being resolved against the working
directory. The guard is enforced inside get_binary_path_versions(), so
no caller can skip it, and the PSQL tool now goes through
does_utility_exist() too.

Reported-by: Harsh Singh
2026-10-24 19:36:13 +05:30
hiteshjambhaleandDave Page 9be31a019f Reject a backslash in a double-quoted identifier in the Import/Export Data query export. #10663
_is_query_parens_balanced() rejected a backslash inside a single-quoted
string but not inside a double-quoted identifier, where it treated the
next quote as closing the token. psql does not: strtokx in
parse_slash_copy takes its escape character from the connection's
standard_conforming_strings setting and applies it to whichever quote
opened the token, so with standard_conforming_strings off the \" in
"a\"b" is an escaped quote and the identifier runs on to the next quote.

That desynchronises our quote state from psql's in the opposite
direction to the case fixed in 1496fabe2, and a query export such as
SELECT "a\"b"c) TO PROGRAM 'cmd' x" therefore passed the balance check
whilst the ) it hid closed the wrapping \copy (...) context, exposing a
live TO PROGRAM clause. psql calls popen() for a client-side
\copy ... TO PROGRAM before the backend sees the statement at all, so
the command runs on the pgAdmin host even though the query is then
rejected as a syntax error. An ordinary PostgreSQL role can set
standard_conforming_strings on itself, and a non-administrator pgAdmin
account holds tools_import_export_data by default, so no privileged
access of either kind is needed.

Apply the same treatment as the single-quoted branch and reject any
backslash encountered whilst scanning a double-quoted identifier, since
the correct interpretation still depends on a server setting we cannot
reliably know at validation time.

Co-authored-by: Dave Page <dpage@pgadmin.org>
Reported-by: Yonghwa Lee of Xint by Theori
2026-10-24 19:36:13 +05:30
145e511f05 Stop libpq using the pgAdmin service account's Kerberos credentials in server mode. #10655
When a connection was not meant to use a Kerberos user's delegated
credentials, pgAdmin removed KRB5CCNAME from its environment, so the
Kerberos library fell back to the default credential cache of the account
pgAdmin runs as. libpq then answered any server that asked for GSSAPI
authentication with that account's ticket, whatever user name the
pgAdmin user gave, so any user could connect as the service account's
principal; gssencmode=disable does not prevent this. A client keytab for
that account had the same effect, even with no cache, as the library
fills the cache from it. On Windows, SSPI used the service account's
logon in the same way. psql was also started with a copy of pgAdmin's
environment, which could hold another user's credential cache whilst that
user was connecting, and the connection made to list a publisher's
publications was not made under the lock that guards it.

In server mode KRB5CCNAME and KRB5_CLIENT_KTNAME now always point at a
file that cannot exist, except whilst a user who logged in with Kerberos
connects to a server with Kerberos authentication enabled, when
KRB5CCNAME is that user's delegated cache as before. Because environment
isolation alone does not stop SSPI or gssproxy, every other connection
also gets require_auth=!gss,!sspi and gssencmode=disable, merged with the
server's own require_auth, which is refused if it allowed only GSS or
SSPI. A Kerberos-allowed connection forces gsslib=gssapi, so libpq uses
the delegated cache rather than the Windows logon. psql and the utilities
receive the same settings as PGREQUIREAUTH, PGGSSENCMODE and PGGSSLIB;
background processes now pass the server's own kerberos_conn instead of
always assuming a Kerberos connection, and the publication lookup
connects under the lock. Desktop mode is unchanged.

The forced require_auth, gssencmode and gsslib are serialised last, so
they win over any value a crafted connection parameter key places before
them, and the final connection string is parsed and refused if any of
them differs from the value forced (or is present where it is left to
the environment), so a smuggled value cannot steer the PSQL tool or a
utility to GSSAPI or SSPI however the parameters were serialised.

A pg_service.conf entry ranks above the PG* environment variables, so
only a service the administrator lists in SERVER_MODE_ALLOWED_SERVICES
can override these settings for the utilities; the documentation says
such an entry must not set them.

Compatibility: in server mode, connecting with the service account's
Kerberos ticket, client keytab or Windows logon (SSPI) no longer works;
only users who log in to pgAdmin with Kerberos can use GSSAPI, with their
own delegated credentials, as the documentation already described. A
server whose require_auth lists only gss or sspi is refused unless the
user logged in with Kerberos (SSPI-only is never usable). require_auth
needs libpq 16 or later; with an older libpq only the KRB5CCNAME and
KRB5_CLIENT_KTNAME isolation applies, which does not cover Windows SSPI
or gssproxy.

Co-authored-by: Dave Page <dpage@pgadmin.org>
Co-authored-by: hiteshjambhale <hitesh.jambhale@enterprisedb.com>
2026-10-24 19:36:12 +05:30
a0c8f4857f Restrict connection services to an administrator's allowlist in server mode. #10654
libpq looks a service up in the connection service file of the account
pgAdmin runs as, and an entry there can hold a password or name a
password file or client certificate. In server mode any user could set a
server's service, or a 'service' connection parameter, to one of those
entries and connect with its credentials. Likewise, a PGPASSWORD or
PGSERVICE variable set for that account was used by libpq for every
connection that had no value of its own, and passed on to the utilities.

In server mode a service may now only be used if it is listed in the new
SERVER_MODE_ALLOWED_SERVICES setting, which is empty by default. Creating
or updating a server, an ad hoc workspace connection or a servers.json
import that names any other service is refused, and connecting to an
existing server, or running psql or a utility for it, fails with a
message that names the setting. The 'servicefile' connection parameter is
refused in server mode, and PGPASSWORD and PGSERVICE are removed from
pgAdmin's environment at startup, with a warning. PGSERVICEFILE and
PGSYSCONFDIR are kept, since they locate the listed services. Desktop
mode is unchanged.

The allowlist is checked again on the final connection string, as libpq
will parse it, so a service smuggled in through a crafted parameter key
is refused however the parameters were serialised. pg_dumpall expands a
--database value containing "=" as a connection string, so the
maintenance database name of Backup Server and Globals is wrapped in one
and a name such as "service=name" no longer selects a service from the
service account's service file. client_files_isolated() treats a missing
PGADMIN_RUNTIME as "not the desktop runtime", so "setup.py load-servers"
no longer fails on any servers.json containing a Service and still
enforces the allowlist in server mode.

The tests run the real job-creation path of every tool that starts a
utility, and check that a service that is not listed is refused before
the utility starts, a listed one is exported as PGSERVICE, and a service
or servicefile connection parameter, or a database name that looks like
a connection string, never selects a service.

Compatibility: in server mode, servers that use a service stop
connecting until the administrator lists it in
SERVER_MODE_ALLOWED_SERVICES, and a PGPASSWORD or PGSERVICE set in the
environment pgAdmin starts with is ignored. "setup.py load-servers" now
refuses a servers.json whose Service is not in
SERVER_MODE_ALLOWED_SERVICES (exit status 1) instead of printing an
error and exiting 0.

Co-authored-by: Dave Page <dpage@pgadmin.org>
Co-authored-by: hiteshjambhale <hitesh.jambhale@enterprisedb.com>
2026-10-24 19:36:12 +05:30
KundanandDave Page 0eefa38f77 Stop leaving server passwords in pgAdmin's own process environment. #10653
To pass a server's password to psql and to the utilities run as background
processes, ServerManager.export_password_env() wrote it into os.environ:
as PGPASSWORD for psql, and under the process ID for a utility. Nothing
removed it again, and pgAdmin's environment is shared by every user's
requests and copied into every process it starts, so another user's later
psql session or utility inherited the password, and libpq read PGPASSWORD
for any connection made without one of its own. In server mode that let
one user connect with another user's saved password.

The password now goes only into the environment built for the process
that needs it: export_password_env() fills in a dict it is given, the
background process adds it to the environment of that process alone, and
psql is started with a copy of pgAdmin's environment plus its password,
rather than with os.environ itself, which get_user_env() also modified by
setting the user's psqlrc and history paths in it. The process executor
removes the variable it reads the password from, so the utility only
sees PGPASSWORD.

There is no compatibility impact: psql and the utilities receive the same
password in the same variable as before.

Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-10-24 19:36:12 +05:30
KundanandDave Page 32db693198 Stop libpq using the pgAdmin service account's own client files in server mode. #10652
When a server had no password file, client certificate or client key
configured, or the configured one could not be found, pgAdmin left the
parameter out of the connection and libpq fell back to ~/.pgpass,
~/.postgresql/postgresql.crt and ~/.postgresql/postgresql.key (or
PGPASSFILE, PGSSLCERT and PGSSLKEY) belonging to the account pgAdmin runs
as. In server mode that let any user connect with the service account's
saved passwords or client certificate, and supplying a copy of its public
certificate was enough for libpq to pair it with the service account's
private key.

In server mode each of these parameters is now always given a value:
the user's own file if one is configured, otherwise a path that can never
be opened, so libpq neither uses nor looks for a default. This applies to
the connection string, to the PGPASSFILE, PGSSLCERT and PGSSLKEY variables
passed to the utilities, and to the direct connection made to list a
publisher's publications. A configured file that does not exist is now
passed on as configured instead of being dropped, so a missing root
certificate or CRL no longer quietly falls back to root.crt or root.crl,
and a CRL directory is now passed on in server mode. The trust settings
(sslrootcert, sslcrl, sslcrldir) are still left to libpq when they are not
configured, as they hold no secret, and "system" is no longer mistaken for
a file name in the subscription connection. Desktop mode is unchanged.

libpq ranks a pg_service.conf entry above the PG* environment variables,
so a service entry that set passfile, sslcert or sslkey still won for
pg_dump, pg_restore, psql and the maintenance tools. In server mode the
three settings are therefore also passed in the --dbname connection
string, which libpq ranks above the service file; pg_dumpall takes them
in a separate --dbname argument so that its per-database pg_dump
processes inherit them. pg_dumpall's --database, the maintenance database
name passed raw, is now wrapped as a connection string too, so a name
such as "passfile=..." cannot bring the service account's files back. The
file settings are chosen from the same source as the environment
variables, so that the two cannot disagree.

Compatibility: server mode deployments that relied on the service
account's ~/.pgpass, PGPASSFILE, default client certificate and key,
PGSSLCERT or PGSSLKEY, or on a passfile, sslcert or sslkey in a
pg_service.conf entry, will need to configure those files on each server
instead. In server mode a pg_dump, pg_restore or psql older than
PostgreSQL 10 fails on the passfile keyword, and a server configured with
an sslcert but no sslkey now fails with "certificate present, but not
private key file" instead of silently using the service account's key.
The container is not affected, as its entrypoint already copies
PGPASS_FILE into the user's storage and sets the password file
explicitly. Passwords in a pg_service.conf entry chosen through the
service setting are not addressed here.

The tests now cover a server whose user password file is held only on
the server row. The auth gating test restores the provider modules it
re-imports, so later OAuth2 tests no longer fail depending on test
order.

Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-10-24 19:36:12 +05:30
KundanandDave Page d761942d0b Restrict sharing a server to administrators in the server API and the servers.json import. #10651
The server dialog only shows the Shared switch to administrators, and
the servers.json import only honoured it for them, but the create and
update endpoints stored whatever 'shared' and 'shared_username' they
were sent. Any user able to register a server could therefore share one
with every other user of a server mode installation. The import had a
similar gap: validate_json_data() removed a non-administrator's "Shared"
entries only after its loop, so an early validation error left them in
the data, and the web path ignored that error, so selecting a shared
entry in a file that also held an invalid one created a shared server.

A non-administrator's request that would share a server is now refused
with a 403. A 'shared' value that changes nothing is still accepted, so
editing a private server is unaffected, and 'shared_username' is dropped
rather than refused because the dialog sends it whenever the username
changes. The import prunes a non-administrator's shared entries before
validating and skips them again for each imported entry, only a JSON
true counts as shared, and validation errors are reported on the web
path too. Copy Server no longer sends shared for a non-administrator
owner.

The existing servers are cleared for "replace" only after the file has
validated, so a refused file no longer deletes them. Servers shared by
non-administrators before the upgrade stay shared until the owner
un-shares them or an administrator changes them; pgAdmin warns about
them at server-mode startup, and the documentation describes this.

Compatibility: a servers.json import in server mode that fails
validation is now refused as a whole on the web path, as it already was
in setup.py.

Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-10-24 19:36:12 +05:30
2afe505ef4 Prevent connection file paths and parameter keys escaping the user's storage directory. #10650
In server mode, get_complete_file_path() joined the user's storage
directory with the path they supplied after stripping only leading
slashes, so a password file, SSL certificate, key, CRL or SSH tunnel
identity file set to "../<another user>/.pgpass" (through the server
dialog, the API or a servers.json import) would connect with another
user's credentials or key. The sslkeylogfile parameter was copied into
the connection string unchanged, so a traversal path let libpq create or
append a file as the pgAdmin service account.

The resolved path, with symbolic links followed, must now stay inside
the user's storage directory, or inside the named shared storage
directory for a "Name:/file" path, as the file manager already requires.
sslkeylogfile is confined the same way, is refused in a shared storage
directory that is read-only for the user, and is no longer inherited by
non-owners of a shared server. A path that escapes, or whose storage
directory cannot be determined, raises PermissionError rather than
letting libpq fall back to its default file, and the message says where
the file has to live. Desktop mode is unchanged.

make_conninfo() quotes connection-parameter values but not their keys,
so a key such as 'sslmode=require passfile' smuggled its own
keyword=value pairs past these checks. Only exact libpq keywords, read
from the linked libpq at runtime, are now accepted as connection
parameter keys: when a server is created, updated, imported from
servers.json or used for an ad-hoc connection, and again when the
connection string is built, for rows saved earlier.

Connecting, the SSH tunnel and the utilities' job creation report a
refused path or key instead of proceeding, and a job whose environment
cannot be resolved is removed rather than left in the Processes list. A
server with a refused path or key can still be listed and edited to
correct it. On Windows, the short path of a not-yet-existing file is
resolved via its parent directory instead of being dropped.

Co-authored-by: Dave Page <dpage@pgadmin.org>
Co-authored-by: hiteshjambhale <hitesh.jambhale@enterprisedb.com>
2026-10-24 19:36:12 +05:30
hiteshjambhale 730d1e783c Refuse hard links and FIFOs in the symlink-race fixes, and stop leaking storage paths in errors. #10649
Follow-up to the Import/Export Servers, File Manager and utility-file
symlink-race fixes.

- Hard links: O_NOFOLLOW refuses only symbolic links, so a second name
  for a file outside the storage directory was still opened.
  _open_upload_target(), _open_read_target() and open_utility_file() now
  refuse a file whose link count is not 1, reporting a file unlinked
  after the open separately from one with several links. For writes,
  O_TRUNC is applied only after that check (via ftruncate), so a
  hard-linked file is never emptied before it is refused.

- FIFOs on write: _open_upload_target() opens non-blocking and accepts
  only a regular file, so a FIFO planted at the path can no longer hang
  an upload, save or export waiting for a reader. _open_beneath()
  reports the ENXIO of a reader-less FIFO as "Not a regular file", so
  Backup, Restore and Import/Export Data get the same message.

- Errors: the Import/Export Servers, save_file, Backup, Restore and
  Import/Export Data handlers return the reason (strerror) rather than
  str(e), which included the absolute storage path, and fall back to the
  exception's text for errors without an errno, so a non-UTF-8
  servers.json is reported instead of failing with a 500.
  load_database_servers() keeps the file path in its messages only for
  the setup.py CLI, and the upload response returns the
  storage-relative name instead of the on-disk path.

Tests cover the hard-link refusal (target left intact), reader-less
FIFOs on the upload and utility-write paths, the non-UTF-8 servers.json
and the handlers' path-free errors.
2026-10-24 19:36:11 +05:30
hiteshjambhale c4321b9968 Fix symlink races in the files handed to Backup, Restore and Import/Export Data. #10648
Backup, Restore and Import/Export Data checked the user's file path
against their storage directory with filename_with_file_manager_path()
and then passed the path to pg_dump, pg_dumpall, pg_restore or psql,
which opened it by name later. A symbolic link swapped in at the leaf or
a parent directory in between redirected the utility outside the storage
directory, so a backup could overwrite, or a restore or \copy read,
another file that pgAdmin's OS user can reach.

In server mode pgAdmin now opens the file itself through the File
Manager's descriptor-relative O_NOFOLLOW walk from the storage directory,
accepts only a regular file, and hands the utility /dev/fd/N.
BatchProcess.start() gains pass_fds and launch-only arguments so the
descriptor is inherited by the process executor and the utility, whilst
the job details stored and shown to the user keep the real path.

Descriptors are only passed on Linux; on macOS and the BSDs the file is
still opened and checked safely but the utility reopens it by name
afterwards. Desktop mode and Windows are unchanged.
2026-10-24 19:36:11 +05:30
hiteshjambhale 99f5606e2e Fix symlink races in Import/Export Servers and File Manager file opens. #10647
dump_database_servers() validated the servers.json path against the
user's storage directory with filename_with_file_manager_path(), then
wrote it with a plain open(), so a symbolic link swapped in at the leaf,
or at any parent directory of it, between the check and the write let the
export overwrite a file outside the storage directory.
load_database_servers() and the import file-listing endpoint had the same
gap on the read side.

A new _open_beneath() opens the storage directory and then walks down to
the file one component at a time, each open relative to the descriptor of
the directory above it and made with O_NOFOLLOW, so the kernel refuses a
symbolic link wherever it appears below the storage root. New files are
created 0o600, and reads accept only a regular file, opened non-blocking
so that a FIFO cannot hang the request. Desktop mode, Windows and the
setup.py CLI path are unchanged.

Reported-by: MUTED CYBERSECURITY S.L.
2026-10-24 19:36:11 +05:30
hiteshjambhale a1a43e8c28 Stop the materialized view refresh redirecting its connection via a crafted database name. #10645
MViewNode.refresh_data() passed the target database's name straight to
psql's --dbname argument. libpq treats a --dbname value containing "="
(or a postgresql:// URI) as a full connection string, so a database
named e.g. 'host=attacker port=5432 dbname=postgres' - creatable by any
role with only CREATEDB - redirects the spawned psql to an attacker host,
leaking the connecting user's saved server password.

Route the name through database_conninfo(), the same helper already used
for backup, restore, maintenance and import/export, so libpq treats it
strictly as a database name and never as connection directions.

Reported-by: Bae Seung-won of Ajou University
2026-10-24 19:36:11 +05:30
Kundan ea293b335e Fix the Statistics node failing to list its children in Object Explorer. #10310 (#10639)
pgAdmin renders its templates with trim_blocks, which removes the newline
after a block tag. nodes.sql ended its WHERE clause with a conditional, so
with neither a statistics id nor schema_diff set, which is what expanding
the Statistics collection sends, the SQL ran into "::oidORDER BY" and the
server rejected it.

Give each condition its own line ending in plain text, and add a test that
renders the template for every parameter combination and runs it.
2026-10-22 18:18:27 +05:30
dependabot[bot] a623526cb7 Javascript dependency: Bump electron-store in /runtime (#10627)
Bumps [electron-store](https://github.com/sindresorhus/electron-store) from 11.0.2 to 12.0.0.
- [Release notes](https://github.com/sindresorhus/electron-store/releases)
- [Commits](https://github.com/sindresorhus/electron-store/compare/v11.0.2...v12.0.0)

---
updated-dependencies:
- dependency-name: electron-store
  dependency-version: 12.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-22 13:30:16 +02:00
dependabot[bot] 39aed6083b Javascript dependency: Bump electron (#10626)
Bumps the runtime-javascript-minor-and-patch group in /runtime with 1 update: [electron](https://github.com/electron/electron).


Updates `electron` from 44.5.1 to 44.7.0
- [Release notes](https://github.com/electron/electron/releases)
- [Commits](https://github.com/electron/electron/compare/v44.5.1...v44.7.0)

---
updated-dependencies:
- dependency-name: electron
  dependency-version: 44.7.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: runtime-javascript-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-22 13:29:52 +02:00
dependabot[bot] 05b2864d32 Python dependency: Update flask-socketio requirement (#10628)
Updates the requirements on [flask-socketio](https://code.miguelgrinberg.com/miguelgrinberg/flask-socketio) to permit the latest version.

---
updated-dependencies:
- dependency-name: flask-socketio
  dependency-version: 5.7.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-22 13:29:19 +02:00
dependabot[bot] 8c5dd5eadb Javascript dependency: Bump follow-redirects in /web (#10638)
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.16.0 to 1.16.1.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.16.0...v1.16.1)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-version: 1.16.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-22 13:29:15 +02:00
dependabot[bot] b345337ddc Javascript dependency: Bump follow-redirects in /runtime (#10637)
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.16.0 to 1.16.1.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.16.0...v1.16.1)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-version: 1.16.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-22 13:29:10 +02:00
Dave Page b8afe34fbb Keep external pages out of the desktop runtime's privileged windows and confine non-prompted downloads to the downloads directory. #10614 (#10616) 2026-10-16 09:38:54 +01:00
Dave Page 7f21dc4610 Reconnect a lost Query Tool connection as the user and role it was changed to. #10613 (#10622) 2026-10-16 03:21:58 +01:00
Dave Page ac76a81ad2 Revert the Query Tool execute option checkboxes when changing an option fails. #10600 (#10621) 2026-10-16 02:29:02 +01:00
Dave Page 5f9909e109 Free Query Tool autocomplete objects when an idle session's connections are released. #10612 (#10625) 2026-10-16 02:26:16 +01:00
Dave Page 31a5c5418c Keep the Query Tool execute options when its transaction is re-created. #10598 (#10599) 2026-10-16 01:07:38 +01:00
Dave Page cc1e1ef184 Remove the dead tree 'loadfail' handler from browser.js. #10601 (#10620) 2026-10-16 00:59:08 +01:00
Dave Page 1402f7d9cd Fix the Jest addNewDatagridRow helper so schema UI specs actually add a row. #10602 (#10624) 2026-10-16 00:46:52 +01:00
Dave Page 6594977cc3 Fix Schema Diff treating a function whose input argument was renamed as two unrelated functions. #10597 (#10623) 2026-10-16 00:30:56 +01:00
Dave Page b98470f327 Allow shift + click to extend the cell range selection in the Query Tool results grid. #8647 (#10617) 2026-10-15 22:27:56 +01:00
Dave Page 35307612fc Fix formatting a view's SQL being treated as a column change that drops and re-creates the view. #9838 (#10591) 2026-10-15 22:21:26 +01:00
Dave Page 8b381912a8 Fix Azure and Google authentication in the cloud deployment wizard. #9921 (#10609) 2026-10-15 21:25:00 +01:00
Dave Page ab749c630c Report a failed autocomplete reconnect in the Query Tool instead of ignoring it. #10604 (#10606) 2026-10-15 20:53:26 +01:00
Dave Page 1cac42d986 Keep Query Tool execution disabled until a restored tab's execute options reach the server. #10618 (#10619) 2026-10-15 20:49:10 +01:00
Dave Page f73b51f912 Fix modal dialogs being hidden from assistive technology by aria-hidden on the application root. #9865 (#10587) 2026-10-15 19:40:21 +01:00
Dave Page 733cd5ba5e Allow the emailed MFA code to be re-entered after an invalid code is entered. #6671 (#10589) 2026-10-15 19:30:20 +01:00
Dave Page 8877330705 Fix Query Tool autocomplete objects being shared between sessions that use the same transaction id. #10607 (#10608) 2026-10-15 18:20:52 +01:00
Dave Page 8d8bcf3748 Fix the Query Tool not re-running the query after reconnecting at a password prompt. #10603 (#10605) 2026-10-15 18:02:30 +01:00
Dave Page 7828c9b2a1 Restore the per-tab toolbar options when Query Tool tabs are restored on relaunch. #9603 (#10593) 2026-10-15 17:29:43 +01:00
Dave Page 09afc34c0e Fix Schema Diff treating functions that differ only in OUT arguments or return type as unrelated objects. #6652 (#10595) 2026-10-15 17:23:43 +01:00
Dave Page 2477a94b32 Fix a flaky Jest test for the connection parameter value dropdown. (#10610) 2026-10-15 15:06:27 +01:00
Dave Page bbb5cc250b Connect the server when changing the Query Tool connection after it was disconnected. #8144 (#10588) 2026-10-15 14:50:25 +01:00
Dave Page 33fab95a73 Fix a database's label staying at '[Disconnecting...]' when disconnecting it fails. #9624 (#10590) 2026-10-15 14:49:51 +01:00
Dave Page 755cfec19e Show fill factor, toast tuple target and parallel workers in the table Properties panel. #9212 (#10594) 2026-10-15 12:34:34 +01:00
Dave Page 5711c4dd5a Keep the AI Assistant's intermediate responses instead of replacing them with placeholder messages. #9818 (#10592) 2026-10-15 12:20:18 +01:00
Dave Page a6374d1ccd Re-sort renamed server groups and other nodes in the Object Explorer instead of waiting for a reload. #8015 (#10586) 2026-10-15 11:45:52 +01:00
Dave Page 78afe89752 Fix Query Tool autocomplete running as the wrong user, or failing, after changing the connection to a different user. #7619 (#10582) 2026-10-15 10:42:16 +01:00
Dave Page 70c6777b5e Fix ERD tables becoming immovable after a Shift-drag selection. #9890 (#10581) 2026-10-15 10:38:55 +01:00
Dave Page 7c5b0b7da7 Fix modal dialogs losing keyboard focus to a tool iframe loading in the background. #9784 (#10583) 2026-10-15 10:38:39 +01:00
Dave Page 472965ec40 Fix the server context menu showing database options after the tree state is restored. #7612 (#10580) 2026-10-15 10:38:24 +01:00
Dave Page 610cad0e0e Select the adjacent tab when the active tab is closed, rather than the left-most. #9130 (#10578) 2026-10-15 10:38:10 +01:00
Dave Page 72ab768b94 Fix the parameter value dropdown keeping stale options when the parameter name is changed. #9630 (#10579) 2026-10-15 10:37:52 +01:00
Sanskar Kharya 5063c76a06 Preserve explicit 24-hour mode in date-time picker popups. #10584 (#10596) 2026-10-15 10:36:29 +01:00
Dave Page 607c9eccbf Remove unused Google API documents, Babel locale data and packaging tools from the packages. #9331 (#10576) 2026-10-14 18:20:56 +01:00
Dave Page e8f7a18c98 Allow the login page to be skipped when OAuth2 is the only authentication source. #9975 (#10575) 2026-10-14 17:19:12 +01:00
Dave Page a00cd1dd43 Fix Query Tool state save/restore failing on installations with a legacy SECRET_KEY. #10573 (#10574) 2026-10-14 17:17:46 +01:00
Dave Page b6a4c7fe15 Document running the container with rootless Podman, and the PUID and PGID environment variables. #9524 (#10572)
* Document running the container with rootless Podman, and the PUID and PGID environment variables. #9524

* Note that the U volume option is recursive and does not relabel for SELinux.
2026-10-14 15:44:33 +01:00
Dave Page d699acab0b Clarify the configuration files documentation. #5369 (#10571)
* Document that config_local.py is lost on upgrade on macOS. #5369

* Retitle the config_py docs page to 'Configuration Files', as it covers all four configuration files. #5369
2026-10-14 14:27:01 +01:00
Hari Prasad 5f6d72c686 Add numpad zoom shortcuts to the Desktop View menu. #10503 (#10533) 2026-10-14 13:24:34 +01:00
Dave Page 50209794d7 Require SSL for pgEdge Starfleet hosts and warn when libpq cannot connect to them. (#10569)
Starfleet endpoints drop SSL connections that arrive without SNI, which
libpq only sends from version 14, and never answer a non-SSL connection.
The cloud wizard now warns when pgAdmin's libpq is older than 14, and
the Register Server dialog defaults sslmode to require for *.pgedge.cloud
hosts, since with prefer any failed SSL attempt is retried without SSL
and reported only as a timeout.
2026-10-14 12:57:08 +01:00
Sanskar Kharya 5515b54d53 Move the 'Returns a set?' option to the Definition tab in the Function dialog. #9264 (#10565)
Also update the documentation and screenshots to match.
2026-10-14 12:08:07 +01:00
Dave Page a0b4c09772 Fix server update ignoring the connected-server check, and Connection.reset() never reconnecting. (#10567) 2026-10-14 11:37:03 +01:00
Dave Page 0389ee789a Bundle Python 3.13.16 in the Windows and macOS packages. (#10566)
Python 3.14 has to wait: the Windows build needs pywinpty, which is held
at 2.0.x for andfoy/pywinpty#545, and 2.0.x cannot be built for 3.14.
Note that beside both pins.
2026-10-14 10:45:54 +01:00
Dave Page 26a7d92b0b Fix the Linux packages shipping a stray copy of Python as venv/bin/𝜋thon. #10414 (#10564)
Python 3.14's venv module creates a "𝜋thon" symlink next to python,
python3 and python3.X (CPython gh-119535). The hash bang fixup runs
"sed -i" over venv/bin/*, which replaces every symlink with a regular
copy of its target; the python* links are recreated afterwards, but the
new alias was not, so packages built against Python 3.14 shipped a full
copy of the interpreter under that name, and dpkg on Ubuntu 26.04 fails
to unpack it. Nothing uses the alias, so remove it when the venv is
created.
2026-10-13 14:56:32 +01:00
Sanskar Kharya e02150e634 Fix the Dashboard Logs tab failing on multi-byte characters split across read chunks. #10511 (#10526)
The Logs tab reads the current log file in fixed-size byte ranges with
pg_read_file(), which raises 'invalid byte sequence' (SQLSTATE 22021)
when a range boundary falls inside a multi-byte character, so Tabular
format failed on logs containing non-ASCII text. The ranges are now read
with pg_read_binary_file(), transported as hex and decoded in pgAdmin
using the server encoding. Tabular reads fetch a few bytes of overlap so
a character split at a page boundary is shown whole on one page, and
genuinely invalid bytes are shown as replacement characters rather than
raising an error. For the EUC family of server encodings a page boundary
can still garble one character, as lead and trail bytes share ranges.

- Keep valid text after an invalid byte near the end of the file, trimming only a character still being written.
- Treat a truncated character in the CJK codecs as incomplete rather than invalid.
- Correct the encoding limitation comment, as GBK and GB18030 are not server encodings.
2026-10-13 13:23:44 +01:00
Dave Page 3e6f0c0703 Make server tests restore the shared test fixture after themselves. #10553 (#10562)
Several tests changed the server dict that the runner shares between all
tests (shared, service, SSH tunnel settings and so on) and never put it
back, so later tests inherited those settings; running the whole server
test package locally made the non-owner tests in
test_server_data_isolation.py fail with HTTP 428.

Move restore_server_fixture_on_cleanup() into servers/tests/utils.py and
call it from every test that modifies the fixture, including the sqleditor
new connection tests that added a password key, and stop the SSH mock
connect test relying on a tunnel_password key leaked by test_add_server.
2026-10-13 13:14:19 +01:00
Dave Page 1b05065eb0 Fix changing an identity column's START value also restarting its sequence. #10550 (#10561)
The column ALTER emitted RESTART SET START whenever START changed,
rewinding the identity sequence so the next generated value could
collide with existing rows; Schema Diff hit this too when only START
differed. RESTART is now emitted only when the sequence is still pending
at its old START with nothing generated since, or when its current value
would fall outside a new MINVALUE or MAXVALUE (which PostgreSQL refuses
without it). To decide, the column update reads last_value and is_called
from the sequence itself when START is set, since
pg_sequence_last_value() is NULL after any RESTART WITH.
2026-10-13 12:57:17 +01:00
Dave Page 8f24dc378d Add a test for Reset discarding pending SQL editor values in dialogs. #10552 (#10560)
The fix for #10357 remounts the dialog form on Reset so that SQL editor
values still waiting to come back through SchemaView are discarded. This
spec types into an SQL field, removes the edit, types again and presses
Reset before SchemaView has passed those values back, then checks that the
original value is shown. Without the remount the editor keeps the last
typed value.
2026-10-13 12:11:02 +01:00
Dave Page f4337dc8c7 Fix the cursor jumping to the start of SQL fields in dialogs after a quick edit and undo. #10551 (#10559)
When an edit and its undo (or a key, Backspace and the same key again) were
all reported before SchemaView passed the first value back, the editor's
pending values held the same text twice. Matching the newest copy dropped the
value in between, which then replaced the document when it came back. Values
come back in order, so InputSQL now matches the earliest copy; if some are
skipped, the leftover entries are cleared by later changes.
2026-10-13 12:10:01 +01:00
Dave Page fd4b47788b Fix column properties reporting an arbitrary parent for columns merged from several parents. #10554 (#10563)
The inherited-columns CTE joins on column name, so a column merged from
more than one parent produced a row per parent, and DISTINCT ON then
kept whichever came first. Order by the inheritance sequence number so
the first parent in inheritance order is always reported.
2026-10-13 12:07:32 +01:00
Dave Page 74003c19dc Fix Schema Diff not removing a column comment that exists only in the target. #10549 (#10556)
A source column without a comment has a description of None, which the
column update template skips, so the comment was reported as a difference
but never dropped. Send an empty string in that case, as the column dialog
does when a comment is cleared, so COMMENT ON COLUMN ... IS '' is
generated.
2026-10-13 12:06:01 +01:00
Dave Page a11fc0b921 Fix valid escapes below U+0100 being rewritten in SQL_ASCII data and names. #10547 (#10558)
The SQL_ASCII codec unescaped every valid \uXXXX and \UXXXXXXXX
sequence, so a value or column name containing '\u0041' was shown as
'A', and saving the row wrote 'A' back.

Decode each byte as latin-1 and only unescape escapes for code points
from U+0100 to U+10FFFF, which are the only ones pgAdmin writes when
encoding. Lower escapes and invalid sequences are kept as their literal
bytes. Encoding is unchanged.

- Decode long runs of backslashes in linear time in the SQL_ASCII codec.
2026-10-13 12:02:55 +01:00
Dave Page 5811f55b08 Fix negative identity column options being dropped from the generated SQL. #10548 (#10557)
The column and table templates only emitted an identity option when its
value was greater than -1, which was meant to skip unset options but
also dropped every negative one. So on a descending identity column,
changing INCREMENT to -2 in the column dialog or a MINVALUE difference
in Schema Diff produced no ALTER at all, and the table's CREATE SQL lost
its INCREMENT, START, MINVALUE and MAXVALUE. Test for an unset option
explicitly instead.
2026-10-13 12:02:05 +01:00
Dave Page d1374536d8 Fix flaky test_windows_pty_failures counting psql emits from other tests. #10546 (#10555)
The tests patch psql.sio.emit globally, so a psql session from another
test that is still running can emit pty-output into the same mock. Only
count the emit calls sent to the test's own room.
2026-10-13 12:01:47 +01:00
Dave Page 04684e798a Fix View/Edit Data failing on SQL_ASCII databases when a name contains a backslash followed by 'u' or 'U'. #5940 (#10545)
pgAdmin uses raw_unicode_escape as the Python codec for SQL_ASCII
connections, and psycopg decodes column names and query text with it.
A name such as "C:\User\te" contains '\U' that is not a valid
\UXXXXXXXX escape, so decoding raised "truncated \UXXXXXXXX escape".

Register a pgAdmin codec that behaves like raw_unicode_escape but keeps
invalid escape sequences as their literal bytes, and use it for
SQL_ASCII. Encoding is unchanged.
- Give the SQL_ASCII codec incremental support, and keep invalid escapes in server errors.
2026-10-13 08:18:24 +01:00
Dave Page 8df5306ebd Fix debugger messages from successive steps running together on one line. #8664 (#10544)
Each poll of the debugger returns its own batch of notices without a
trailing newline, so appending them directly ran messages from separate
steps together. Start each appended batch on a new line.
- Clarify that debugger message batches only usually lack a trailing newline.
2026-10-13 08:03:35 +01:00
Dave Page ab632646ed Fix the cursor jumping to the start of SQL fields in dialogs when keys are pressed together. #10357 (#10543)
SchemaView passes a field's value back a render or two after the change,
so when two keys are pressed almost at once the SQL editor could be handed
the value from the first key whilst already holding the second. Applying
that older value replaced the whole document, which moved the cursor to
the start. InputSQL now remembers the values the editor has reported and
ignores one that is older than the editor's current content.
- Remount the dialog form on Reset so pending SQL editor values are discarded.
2026-10-13 07:07:43 +01:00
Dave Page 43d1d59e00 Fix Schema Diff reporting identical tables as different when a foreign key's referenced table has a dropped column. #10446 (#10542)
pg_constraint.confkey holds the attribute numbers of a foreign key's
referenced columns, which differ between databases when a column has been
dropped from the referenced table in only one of them. The referenced
columns are already compared by name, so ignore confkey as conkey already
is.

A foreign key whose referenced columns differ is now dropped and
recreated, rather than being reported as different with an empty diff.
2026-10-13 06:31:01 +01:00
Dave Page 149170195d Fix the generated SQL to use a single GRANT statement for roles with identical privileges. #6231 (#10541)
parse_priv_to_db() now merges ACL entries that grant exactly the same
privileges, from the same grantor, into one entry listing every grantee,
so the templates for all object types produce
'GRANT ... TO role1, role2;' rather than one statement per role.

A privilege whose grantee is changed away from PUBLIC now also revokes
PUBLIC's privileges, rather than leaving them in place.
2026-10-13 05:36:19 +01:00
Dave Page e0a2d2138e Fix Schema Diff repeating unchanged column comments and identity options. #10422 (#10540)
Schema Diff passes a changed column with all of its properties, but the
column update template emitted COMMENT ON COLUMN and every identity
sequence option without comparing them with the column as it stands.
So any difference in an identity column repeated its unchanged comment,
and repeated START as RESTART SET START, which rewinds the identity
sequence on the target. Only emit those that actually differ.
2026-10-13 05:15:06 +01:00
Dave Page b10718d616 Fix Reset Layout dropping Query Tool tabs from the saved application state. #10424 (#10539)
resetLayout() re-opened the non-default tabs without their metaData, so
the layout saved straight afterwards stored them as bare ids and loadTab()
had nothing to rebuild them from on the next load. Their group is now
carried over as well, rather than falling back to 'default'.
2026-10-13 04:13:55 +01:00
Dave Page 3ec0aafa36 Fix UNLOGGED handling for partitioned tables and their partitions. #9057, #9836 (#10538)
PostgreSQL 18 rejects UNLOGGED on a partitioned table, in both CREATE
TABLE and ALTER TABLE ... SET UNLOGGED/LOGGED, so on PG18 and later
the Unlogged switch is now disabled for partitioned tables (including
a partitioned partition) and the generated CREATE, ALTER and reverse
engineered SQL no longer include it. Leaf partitions can still be
unlogged, and older servers are unchanged.

The Partitions SQL section of a partitioned table's script also now
keeps UNLOGGED for partitions that are unlogged, which it previously
dropped.
2026-10-13 04:03:21 +01:00
Dave Page 6a90e4f837 Remove the dead usr key from sqleditor.connect_server URLs. #10418 (#10536)
The route has no user placeholder, so url_for() always dropped it and
the backend never read it; the now-unused user argument is removed
from the connect-server helpers too.
2026-10-13 02:44:28 +01:00
Dave Page ccdb1f6271 Fix the Query Tool saving files that were loaded as latin-1 back as UTF-8. #10531 (#10537)
The latin-1 read fallback now records the encoding, and encodings are
tracked per resolved file path rather than by basename, and only after
a save succeeds.
2026-10-13 02:35:01 +01:00
Dave Page 3d5661ed87 Refresh a stale ServerManager when a server id is reused. #6090 (#10312)
A cached manager whose server definition no longer matches is rebuilt,
and the owner's settings are deep-copied before being overlaid for
shared-server users.
2026-10-13 02:14:07 +01:00
Dave Page 6404865bd5 Restore SCHEMA_VERSION 53, reverted by mistake when squashing #10330.
The #10330 branch added and then dropped a schema version bump; replayed
on top of #10506, which also took version 53, the squash set it back to
52 even though the server_passexec_name migration remains.
2026-10-13 01:26:42 +01:00
Dave Page e28b84ed67 Restore tags for standard users on shared servers, and never inherit the owner's passfile. #10136 (#10330)
Tags are copied to a user's shared server entry, whilst passfile is
treated like passwords, SSH keys and SSL client files and is never
copied from or overlaid with the owner's value.
2026-10-13 01:26:15 +01:00
Dave Page fc12b2e36b Pass every supported connection parameter to the utilities. (#10450)
Connection parameters with a libpq environment variable are exported to
pg_dump, pg_restore, psql and the other utilities, PGSERVICE comes from
the per-user server manager, and boolean parameters stored as strings
are normalised consistently with the main connection path.
2026-10-13 01:21:49 +01:00
Dave Page 34908c4093 Spawn psql directly on Windows instead of via cmd.exe. (#10453)
psql is launched directly through pywinpty, read errors end the session
cleanly, spawn failures are reported to the terminal, and the pty is
closed when the session ends.
2026-10-13 00:58:14 +01:00
Dave Page 5a56a3f3dc Allow editing data through simple auto-updatable views. #2363 (#10322)
Views with a single base table, all of its primary key columns exposed,
no INSTEAD OF triggers and no rules other than _RETURN can be edited in
View/Edit Data. Updates and deletes are checked row by row, and adding
rows is disabled because inserts through views are not supported.
2026-10-13 00:56:35 +01:00
Dave Page bee294a373 Normalise the dashboard TPS graph by the measured time between samples. #10273 (#10324) 2026-10-13 00:30:24 +01:00
Dave Page 224c486c58 Exclude non-editable alias and expression columns from Query Tool UPDATE saves. #10103 (#10329) 2026-10-12 23:51:08 +01:00
Dave Page 2a952d678d Fix the UI language not persisting beyond the request that set it in server mode. #10347 (#10351)
The chosen language is now kept in the session and cookie, and any
value not in config.LANGUAGES is ignored.
2026-10-12 23:46:37 +01:00
Dave Page 3a6f86a711 Fix OpenAI streaming tool calls being split into two entries. #10348 (#10352)
Accumulate Responses API function calls by item, treating output_index
and the item id as names for the same call, and use
response.output_item.done for the final name, call_id and arguments.
2026-10-12 23:29:25 +01:00
Dave Page e85db0fb8b Allow ADMIN OPTION holders to manage Group Role membership. #9450 (#10315)
Users holding ADMIN OPTION on a role, directly or through an inherited
membership as PostgreSQL itself allows, can now change its members,
whilst all other property changes still require CREATEROLE.
2026-10-12 23:23:48 +01:00
Dave Page 0cbddf21ba Fix the hardcoded table OID in the column properties query. #10534 (#10535)
The inherited-columns CTE compared pg_inherits.inhrelid with a fixed
OID instead of the table being queried, so inherited columns were never
reported as such on PostgreSQL 14 and later.
2026-10-12 23:15:52 +01:00
Dave Page e2e588c324 Skip virtualisation for small DataGridView grids to avoid a re-measure on tab show. #10143 (#10331) 2026-10-12 22:58:30 +01:00
Dave Page 6302a70316 Drop the scaffolding default partition after Schema Diff rebuilds a partitioned table. #10301 (#10316)
The temporary default partition is dropped when empty and is not created
at all for hash-partitioned tables, which cannot have one.
2026-10-12 22:17:59 +01:00
Dave Page c41b606795 Replace free-text server-mode password exec commands with an administrator allowlist. (#10506)
In server mode, users choose a password exec command by name from
SERVER_PASSEXEC_COMMANDS rather than entering a command line. Existing
commands are converted on upgrade once the allowlist is configured; if
it is empty the conversion is postponed and a warning is logged.
2026-10-12 21:56:11 +01:00
Dave Page d924c15e79 Pass the target database to utilities as a connection string. #10463 (#10464)
The database is passed as a dbname= connection string, quoted when
needed, so service files and unusual names work, and backup and
import/export require a database for object-level jobs.
2026-10-12 21:47:33 +01:00
Dave Page 1530b3551d Don't refuse symlinks or force 0o600 permissions when saving files in desktop mode. #10482 (#10529)
O_NOFOLLOW and the 0o600 mode are only applied in server mode, and the
symlink refusal message is only reported when O_NOFOLLOW was set.
2026-10-12 21:34:38 +01:00
Dave Page 32f9b4a8f6 Fix Schema Diff scripts that convert a column to or from SERIAL. #10292 (#10318)
Converting a plain column to SERIAL now creates the sequence with the
source sequence's own type, moves it past existing values and restores
the nextval() default; converting away from SERIAL drops the default
before the owned sequence.
2026-10-12 20:50:45 +01:00
Dave Page 6b8394fe31 Write cloud wizard credentials through to the session store for AWS, Azure and Google. #10527 (#10528)
The providers keep credentials and authentication state in nested dicts
in the Flask session, which ManagedSession does not detect as modified,
and FileBackedSessionManager may also defer the disk write. Add a
write_session_through() helper that sets both session.modified and
session.force_write, and call it wherever a provider stores or clears
state that a later request depends on.
2026-10-12 20:08:22 +01:00
Dave Page a9f2cb5405 Fix the Object Explorer shortcut not moving keyboard focus into the tree. (#10294)
The shortcut called focus() on the rc-dock tab pane, a plain div that
cannot take focus, so focus stayed where it was. Focus the react-aspen
tree inside the panel instead, which is already focusable, and draw its
focus indicator with the theme's activeBorder colour on :focus-visible.
2026-10-12 20:05:50 +01:00
Dave Page 7c974c005c Restore remembering the last visited directory in Desktop file dialogs. #10226 (#10327)
Electron 43 deliberately stopped remembering the last folder used by the
native open and save dialogs, so they always opened in Downloads. Track the
last visited directory in the runtime's config store and pass it as
defaultPath whenever the caller has not specified a location.
2026-10-12 17:17:52 +01:00
Dave Page b3a941c469 Add JSON and XML export, output encoding, BOM and copy-with-headers options to the Query Tool results. #3205, #4128, #4129, #6695 (#10062)
Results can now be saved as JSON or XML as well as CSV, with preferences
for the output file encoding, prepending a byte order mark to CSV/TXT
files, and the default state of the grid's copy-with-headers toggle.
2026-10-12 17:17:43 +01:00
Dave Page 4682025f0c Fix BEGIN, COMMIT and ROLLBACK silently failing in the Query Tool under server cursor mode. #8991 (#10321)
execute_void() reused the cached server-side cursor, whose execute() cannot
run a transaction-control statement, and the resulting exception was
swallowed, so the statement never reached the database. Run such statements
through a throwaway plain cursor instead, and guard poll()'s error path
against a cursor with no query.
2026-10-12 17:16:32 +01:00
Dave Page e5b6728fa9 Improve keyboard shortcuts for tab switching, line duplication in the SQL editor, and Enter/Escape in dialogs. #3834, #5691, #7167, #7232 (#10067)
Tab switching now works when focus is inside a tool and defaults to
Ctrl+Alt+PageUp/PageDown, Ctrl/Cmd+Shift+D duplicates the current line or
selection in the SQL editor, and dialogs handle Enter and Escape
consistently.
2026-10-12 17:16:28 +01:00
Dave Page fad01ed776 Add the PostgreSQL 18 options to the Backup, Backup Server and Restore dialogs. #9064, #9066 (#10060)
Add --statistics-only, --no-policies, --no-data, --no-schema,
--no-statistics, --statistics and --sequence-data where the utilities
support them, gated on server version 18, and suppress combinations that
pg_dump, pg_dumpall and pg_restore would reject. The pg_dumpall --format
and pg_restore --exclude-database/--globals-only options were reverted
before PostgreSQL 18.0 and so are not included.
2026-10-12 17:16:24 +01:00
Dave Page d5bd079593 Fix index and constraint columns not being shown when their names require quoting. #6481 (#10039)
The expression check compared pg_get_indexdef() output, which is quoted,
with the raw attname, so such columns were treated as expressions and
dropped. Compare against quote_ident(attname) instead, and replace the
.strip('"') calls with an unquote_ident() helper that also unescapes
doubled inner quotes.
2026-10-12 17:16:20 +01:00
Dave Page 5fc540af73 Fix the collation and ctype query error for databases with a non-default LC_COLLATE. #9798 (#10040)
get_ctypes.sql wrapped a multi-row UNION in a scalar subquery, which failed
when a libc database's collation and ctype differed. Rewrite it as a flat
UNION, add a 15_plus variant, and read datlocale for ICU and builtin
providers on PostgreSQL 17+.
2026-10-12 17:16:17 +01:00
Dave Page 1058f34c52 Return False instead of raising when the external config database is unreachable. (#10052)
check_external_config_db() let connection failures and malformed URIs
propagate as exceptions. Create the engine inside the try block, return
False on any failure, and dispose of the engine in a finally block.
2026-10-12 17:16:13 +01:00
Dave Page 3d3eb8feb9 Disable the SSH agent when an SSH tunnel identity file or password is provided. #9814 (#10044)
SSHTunnelForwarder defaults allow_agent to True, so pgAdmin probed the
agent even when it had a credential of its own. Disable the agent in that
case, keeping it enabled when neither is configured.
2026-10-12 17:16:10 +01:00
Dave Page 125cb3007f Fix the OAuth2 userinfo request crashing when the endpoint is configured as None. #10349 (#10353)
The shipped OAUTH2_CONFIG template sets OAUTH2_USERINFO_ENDPOINT to None,
but get_user_profile() only checked whether the key was present, so it
called client.get(None). Check whether the value is set instead, apply the
same check to OAUTH2_LOGOUT_URL and OAUTH2_ADDITIONAL_CLAIMS, and clear a
stored logout URL when the provider has none or the callback fails.
2026-10-12 17:16:06 +01:00
Dave Page fa9762f345 Fix the MAINTAIN privilege being silently dropped for views and materialised views on PostgreSQL 17+. #10350 (#10354)
The PG17+ allowed_privs.json files for views and materialised views were
placed directly in the 17_plus bucket rather than under its sql/
subdirectory, so the versioned template loader fell back to the default
list, which lacks MAINTAIN. Move them under sql/ and add tests covering
the template path and granting MAINTAIN through RE-SQL.
2026-10-12 17:16:02 +01:00
Dave Page d24b946909 Remove the SonarQube scan workflow. 2026-10-12 17:11:46 +01:00
Yousif Wael bdb652b772 Remove inherited columns from the Columns tab when their parent table is removed after reopening a table. #10470 (#10504)
get_formatted_columns() copied the parent table name onto inherited columns
loaded from a saved table's properties, but not the parent's OID, so the
table dialog could not match those columns when the parent was removed from
'Inherited from'. Keep the first parent's OID, matching what the dialog does
when parents are added interactively.
2026-10-12 17:06:12 +01:00
dev-hari-prasad aaa0c8f14d Fix duplicated content when opening large non-UTF-8 files in the Query Tool. #10462 (#10508)
Files are streamed to the Query Tool in 4 MB chunks. If a byte that is not
valid UTF-8 appeared after the first chunk, the resulting UnicodeDecodeError
caused the file to be re-read from the start as latin-1, after earlier chunks
had already been sent, so they were delivered twice.

Check that the whole file decodes with the detected encoding before streaming
anything, falling back to latin-1 up front if it does not. Also replace the
deprecated codecs.open() with open(..., newline='') to preserve line endings.
2026-10-12 17:04:27 +01:00
Sanskar Kharya 641173d0fd Show default privileges in the Database properties panel. #10401 (#10502) 2026-10-12 17:03:10 +01:00
Dave Page ebe4617c00 Add a macOS 26 layered app icon with dark, clear and tinted variants. (#10530)
* Add a macOS 26 layered app icon with dark, clear and tinted variants.

The new pgAdmin4.icon Icon Composer document splits Slonik into body and
line layers over the existing light gradient, using the system dark fill
in dark mode. It is compiled ahead of time into Assets.car, so the build
does not need Xcode 26, and pgAdmin4.icns remains the icon on older
releases.

Closes #10473

* Match the macOS 26 icon's Slonik to the old icon's size and drop its glow.

Remove the thick white silhouette from the body layer, soften the group
shadow, and scale and position Slonik to match pgAdmin4.icns.

* Thin the macOS 26 icon's white lines to match pgAdmin4.icns.
2026-10-12 16:43:22 +01:00
Dave Page a4bdcff7dc Add pgEdge Starfleet to the cloud deployment wizard. (#10499)
* Add a pgEdge Starfleet API client for cloud deployment.

* Add a pgacloud provider for pgEdge Starfleet.

* Add the pgEdge Starfleet cloud deployment blueprint.

* Return the generated pgEdge Starfleet password once on deployment and allow saving it.

* Add pgEdge Starfleet to the Deploy Cloud Instance wizard.

* Test the Starfleet password is fetched once and validate the save request body.

* Show the generated pgEdge Starfleet password once after deployment.

* Document pgEdge Starfleet cloud deployment.

* Show the Starfleet password dialog at most once per job and handle copy failures.

* Wait for the Starfleet instance schema before rendering its form.

The schema is built after an asynchronous client IP lookup, but SchemaView
takes its initial data from the first schema it receives, so mounting it
early left the deployment type unset and hid the managed-only fields.

* Keep the Starfleet token for each deployment job until it completes.

The wizard clears its cloud session as soon as the deployment starts, so
the token was gone by the time the job finished and the generated
password could never be fetched. Copy the token for the job when it is
started, read the password with that copy, and discard it on completion.

* Show the reason a cloud deployment failed.

pgacloud prints the provider's error as JSON before it exits, but the
failure path ignored it, so the user saw only a generic process failure
whilst the server quietly vanished from the tree. Pass the message
through update_server and show it once per job as a plain-text error.

* Keep the cloud deployment failure message until it is dismissed.

* Explain an empty Starfleet BYOC cluster list.

* Wait for Starfleet connection details before finishing a deployment.

* Handle malformed Starfleet responses without a server error.

* Clear the Starfleet PostgreSQL version when the deployment type changes.

* Show the Starfleet size label in the deployment summary.

* Stop logging the values of a background process's environment.

* Use the official pgEdge logo for the Starfleet provider.

* Only mount the selected provider's credentials form in the cloud wizard.

* Require HTTPS and handle malformed pgEdge Starfleet responses.

Addresses CodeRabbit review on #10499: the API client refuses a non-HTTPS
URL before sending credentials, a 2xx body that is not JSON or lacks an
access token raises StarfleetError, and the provider and credential check
report an unexpected response shape instead of failing with a traceback.

* Reject an empty or non-string pgEdge Starfleet access token.

* Note that the pgEdge Starfleet API URL must use HTTPS.

* Add screenshots to the pgEdge Starfleet deployment documentation.

* Update the cloud provider screenshot to include pgEdge Starfleet.

* Remove pgEdge Starfleet BYOC support from the cloud deployment wizard.

Only Managed databases are now offered, so the Deployment type selector,
the cluster list, the BYOC PostgreSQL version list and the BYOC capability
probe are gone, along with the --kind and --cluster-id options of
pgacloud's starfleet create-instance command.

* Regenerate the Starfleet instance and review screenshots without the deployment type.

* Retry transient pgEdge Starfleet polling errors and write job tokens through.

A network error, rate limit or server error whilst waiting for a new
database no longer ends the deployment, leaving the database running in
Starfleet but removed from pgAdmin; polling now retries until its
deadline, failing at once only on other client errors.

The job's copy of the access token is now written to the session store
immediately, so a status poll handled by another worker can still fetch
the generated password.

* Write the pgEdge Starfleet wizard token through, and warn that a failed deployment may leave the database behind.
2026-10-12 14:28:49 +01:00
dependabot[bot] d082e8db27 Javascript dependency: Bump postcss-selector-parser in /web (#10523)
Bumps [postcss-selector-parser](https://github.com/postcss/postcss-selector-parser) from 7.1.5 to 7.1.6.
- [Release notes](https://github.com/postcss/postcss-selector-parser/releases)
- [Changelog](https://github.com/postcss/postcss-selector-parser/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss-selector-parser/compare/7.1.5...7.1.6)

---
updated-dependencies:
- dependency-name: postcss-selector-parser
  dependency-version: 7.1.6
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-12 09:17:48 +01:00
dependabot[bot] a3ec78d30c Javascript dependency: Bump source-map-js from 1.2.1 to 1.2.2 in /web (#10522)
Bumps [source-map-js](https://github.com/7rulnik/source-map-js) from 1.2.1 to 1.2.2.
- [Release notes](https://github.com/7rulnik/source-map-js/releases)
- [Changelog](https://github.com/7rulnik/source-map-js/blob/main/CHANGELOG.md)
- [Commits](https://github.com/7rulnik/source-map-js/compare/v1.2.1...v1.2.2)

---
updated-dependencies:
- dependency-name: source-map-js
  dependency-version: 1.2.2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-12 09:17:22 +01:00
dependabot[bot] 2b7a331896 Javascript dependency: Bump handlebars from 4.7.9 to 4.7.10 in /web (#10525)
Bumps [handlebars](https://github.com/handlebars-lang/handlebars.js) from 4.7.9 to 4.7.10.
- [Release notes](https://github.com/handlebars-lang/handlebars.js/releases)
- [Changelog](https://github.com/handlebars-lang/handlebars.js/blob/v4.7.10/release-notes.md)
- [Commits](https://github.com/handlebars-lang/handlebars.js/compare/v4.7.9...v4.7.10)

---
updated-dependencies:
- dependency-name: handlebars
  dependency-version: 4.7.10
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-12 09:16:57 +01:00
Dave Page 79d138867a Require Flask-Security-Too 5.8.3 or later for the open redirect fix. (#10524)
5.8.3 fixes an open redirect in Flask-Security's default configuration
(GHSA-ccgp-pv8r-95wm). The fix is also in 5.9.1, but 5.9 needs Python
3.11 or later and removes get_post_login_redirect(), which pgAdmin
imports, so raise the lower bound within the 5.8 series instead.
2026-10-09 21:43:55 -04:00
dependabot[bot] 9712467844 Javascript dependency: Bump @mui/x-date-pickers in /web (#10519)
Bumps [@mui/x-date-pickers](https://github.com/mui/mui-x/tree/HEAD/packages/x-date-pickers) from 8.29.3 to 9.15.0.
- [Release notes](https://github.com/mui/mui-x/releases)
- [Changelog](https://github.com/mui/mui-x/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mui/mui-x/commits/v9.15.0/packages/x-date-pickers)

---
updated-dependencies:
- dependency-name: "@mui/x-date-pickers"
  dependency-version: 9.15.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-09 19:23:16 -04:00
dependabot[bot] 347312d8f7 Python dependency: Bump the regression-python-minor-and-patch group (#10513)
Bumps the regression-python-minor-and-patch group in /web/regression with 3 updates: [azure-identity](https://github.com/Azure/azure-sdk-for-python), [google-auth-oauthlib](https://github.com/googleapis/google-cloud-python) and [selenium](https://github.com/SeleniumHQ/Selenium).


Updates `azure-identity` from 1.25.3 to 1.26.0
- [Release notes](https://github.com/Azure/azure-sdk-for-python/releases)
- [Commits](https://github.com/Azure/azure-sdk-for-python/compare/azure-identity_1.25.3...azure-identity_1.26.0)

Updates `google-auth-oauthlib` from 1.4.1 to 1.5.0
- [Release notes](https://github.com/googleapis/google-cloud-python/releases)
- [Changelog](https://github.com/googleapis/google-cloud-python/blob/main/packages/gcp-sphinx-docfx-yaml/CHANGELOG.md)
- [Commits](https://github.com/googleapis/google-cloud-python/compare/google-auth-oauthlib-v1.4.1...google-auth-oauthlib-v1.5.0)

Updates `selenium` from 4.49.0 to 4.50.0
- [Release notes](https://github.com/SeleniumHQ/Selenium/releases)
- [Commits](https://github.com/SeleniumHQ/Selenium/compare/selenium-4.49.0...selenium-4.50.0)

---
updated-dependencies:
- dependency-name: azure-identity
  dependency-version: 1.26.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: regression-python-minor-and-patch
- dependency-name: google-auth-oauthlib
  dependency-version: 1.5.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: regression-python-minor-and-patch
- dependency-name: selenium
  dependency-version: 4.50.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: regression-python-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-09 19:16:15 -04:00
dependabot[bot] 5065de5ac3 Javascript dependency: Bump the runtime-javascript-minor-and-patch group (#10512)
Bumps the runtime-javascript-minor-and-patch group in /runtime with 3 updates: [electron](https://github.com/electron/electron), [eslint](https://github.com/eslint/eslint) and [globals](https://github.com/sindresorhus/globals).


Updates `electron` from 44.4.5 to 44.5.1
- [Release notes](https://github.com/electron/electron/releases)
- [Commits](https://github.com/electron/electron/compare/v44.4.5...v44.5.1)

Updates `eslint` from 10.11.0 to 10.12.0
- [Release notes](https://github.com/eslint/eslint/releases)
- [Commits](https://github.com/eslint/eslint/compare/v10.11.0...v10.12.0)

Updates `globals` from 17.12.0 to 17.13.0
- [Release notes](https://github.com/sindresorhus/globals/releases)
- [Commits](https://github.com/sindresorhus/globals/compare/v17.12.0...v17.13.0)

---
updated-dependencies:
- dependency-name: electron
  dependency-version: 44.5.1
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: runtime-javascript-minor-and-patch
- dependency-name: eslint
  dependency-version: 10.12.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: runtime-javascript-minor-and-patch
- dependency-name: globals
  dependency-version: 17.13.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: runtime-javascript-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-09 19:15:36 -04:00
Dave Page a5aa42843c Fix invalid SQL from Maintenance dialog REINDEX ... CONCURRENTLY. #10251 (#10314) 2026-10-09 18:51:04 -04:00
Dave Page ecb6446c31 Remove unused JavaScript and Python dependencies, and correct the dependency groups. (#10500) 2026-10-02 17:41:15 +01:00
dependabot[bot] ca21e94436 Javascript dependency: Bump webpack-cli from 6.0.1 to 7.2.3 in /web (#10495)
Bumps [webpack-cli](https://github.com/webpack/webpack-cli) from 6.0.1 to 7.2.3.
- [Release notes](https://github.com/webpack/webpack-cli/releases)
- [Changelog](https://github.com/webpack/webpack-cli/blob/main/CHANGELOG.md)
- [Commits](https://github.com/webpack/webpack-cli/compare/webpack-cli@6.0.1...webpack-cli@7.2.3)

---
updated-dependencies:
- dependency-name: webpack-cli
  dependency-version: 7.2.3
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-02 16:20:48 +01:00
dependabot[bot] a3ffb577ae Javascript dependency: Bump react-dropzone from 15.0.0 to 20.1.2 in /web (#10494)
Bumps [react-dropzone](https://github.com/react-dropzone/react-dropzone) from 15.0.0 to 20.1.2.
- [Release notes](https://github.com/react-dropzone/react-dropzone/releases)
- [Commits](https://github.com/react-dropzone/react-dropzone/compare/v15.0.0...v20.1.2)

---
updated-dependencies:
- dependency-name: react-dropzone
  dependency-version: 20.1.2
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-02 16:20:08 +01:00
dependabot[bot] c711abe98e Javascript dependency: Bump the web-javascript-minor-and-patch group (#10493)
Bumps the web-javascript-minor-and-patch group in /web with 3 updates: [ip-address](https://github.com/beaugunderson/ip-address), [postcss](https://github.com/postcss/postcss) and [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint).


Updates `ip-address` from 10.5.0 to 10.7.2
- [Release notes](https://github.com/beaugunderson/ip-address/releases)
- [Commits](https://github.com/beaugunderson/ip-address/compare/v10.5.0...v10.7.2)

Updates `postcss` from 8.5.26 to 8.5.28
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss/compare/8.5.26...8.5.28)

Updates `typescript-eslint` from 8.70.1 to 8.71.0
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.71.0/packages/typescript-eslint)

---
updated-dependencies:
- dependency-name: ip-address
  dependency-version: 10.7.2
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: web-javascript-minor-and-patch
- dependency-name: postcss
  dependency-version: 8.5.28
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: web-javascript-minor-and-patch
- dependency-name: typescript-eslint
  dependency-version: 8.71.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: web-javascript-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-02 16:19:17 +01:00
dependabot[bot] b8dcd80ae1 Python dependency: Update pycodestyle requirement in /web/regression (#10492)
Updates the requirements on [pycodestyle](https://github.com/PyCQA/pycodestyle) to permit the latest version.
- [Release notes](https://github.com/PyCQA/pycodestyle/releases)
- [Changelog](https://github.com/PyCQA/pycodestyle/blob/main/CHANGES.txt)
- [Commits](https://github.com/PyCQA/pycodestyle/compare/2.14.0...2.15.0)

---
updated-dependencies:
- dependency-name: pycodestyle
  dependency-version: 2.15.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-02 16:19:12 +01:00
dependabot[bot] 0360a223a4 Javascript dependency: Bump electron (#10489)
Bumps the runtime-javascript-minor-and-patch group in /runtime with 1 update: [electron](https://github.com/electron/electron).


Updates `electron` from 44.4.3 to 44.4.5
- [Release notes](https://github.com/electron/electron/releases)
- [Commits](https://github.com/electron/electron/compare/v44.4.3...v44.4.5)

---
updated-dependencies:
- dependency-name: electron
  dependency-version: 44.4.5
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: runtime-javascript-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-02 16:19:06 +01:00
Dave Page 53ccc753e3 Align the cloud provider icons and labels in the deployment wizard. (#10498) 2026-10-02 16:03:13 +01:00
Murtuza ZabuawalaandDave Page 9f9bb553c4 Add a Statistics node for managing extended statistics. #2018 (#10310)
Adds browser support for PostgreSQL 14+ extended statistics objects
(CREATE STATISTICS), with the create/edit dialog, reverse engineered SQL,
the computed values ANALYZE collected where the role may see them, and
schema diff support. Completes Murtuza Zabuawala's #9748.

Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-10-02 11:23:44 +01:00
Bea SteersandDave Page a807c99daf Allow an OAuth2 claim to restrict which shared servers a user can see. #9704 (#10234)
Adds OAUTH2_SERVER_GROUP_CLAIM and OAUTH2_SERVER_GROUP_CLAIM_MAPPING. When
the claim is configured for a provider, shared servers owned by other users
are only visible and accessible if their server group's name appears in the
(optionally mapped) claim values; if the claim is missing, none are. The
user's own servers, and users of other authentication methods, are
unaffected. The claim is resolved at login and only stored once the login
has been authorised.

Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-10-02 09:26:27 +01:00
Rohit BhatiandDave Page 86f164d60c Fixed View/Edit Data not handling generated columns properly. #9672 (#9761)
Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-10-02 09:06:51 +01:00
dependabot[bot] dee788c581 Javascript dependency: Bump devalue from 5.9.2 to 5.9.4 in /web (#10488) 2026-10-02 09:00:46 +01:00
dev-hari-prasadandDave Page 7d3a170b9e Fix Kerberos login failures returning a 500 JSON response, and first-time auto-created Kerberos logins being rejected. #10419 (#10455)
When SPNEGO negotiation failed, the exception object was passed to flash(), so the session could not be serialised and the login page was replaced by a 500 JSON response. A generic message is now flashed; the detail is already logged.

Also fix a redirect to a non-existent 'authenticate.kerberos_login' endpoint (it is 'kerberos.login'), which had caused every Kerberos mock test to skip unconditionally, and return the username from Kerberos auto-creation so a user's first login is not rejected with "Incorrect username or password".

Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-10-01 17:01:38 +01:00
Kundan Sable 467a200ca4 Fix 'Cannot have two HTML5 backends at the same time' in DataGridView. #10485 (#10487)
Share one explicit react-dnd manager between DataGridView and PgTreeView. react-arborist bundles react-dnd 14, which stores its manager under the same global key as react-dnd 16 but keeps a separate reference count, so unmounting one provider could drop the manager while its HTML5 backend was still attached to window.
2026-10-01 16:53:57 +01:00
dependabot[bot] cf2c096c4f Update @tanstack/react-table to 9.2.4 and migrate to the v9 API. (#10338)
Moves table construction to useTable() with a shared tableFeatures() registry (filtering, sorting, selection, expanding, sizing/resizing, visibility, row models, sort and filter functions), renames sortingFn to sortFn, adapts to v9 state access, prototype-bound row/cell methods and getRowCanExpand, feeds the DataGridView search state through table state instead of setOptions(), and lets Jest transform the ESM-only @tanstack packages.
2026-10-01 16:42:32 +01:00
dependabot[bot] e64b766ca3 Javascript dependency: Bump brace-expansion from 5.0.9 to 5.0.12 in /runtime (#10480)
Bumps [brace-expansion](https://github.com/juliangruber/brace-expansion) from 5.0.9 to 5.0.12.
- [Release notes](https://github.com/juliangruber/brace-expansion/releases)
- [Commits](https://github.com/juliangruber/brace-expansion/compare/v5.0.9...v5.0.12)

---
updated-dependencies:
- dependency-name: brace-expansion
  dependency-version: 5.0.12
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-01 14:37:47 +01:00
dependabot[bot] cd82c8e4ec Javascript dependency: Bump the web-javascript-minor-and-patch group across 1 directory with 30 updates (#10486)
Also points the react-checkbox-tree webpack alias at lib/index.js, the 2.1 ESM build, as lib/index.esm.js is a stale 2.0.2 build that leaves the app blank.
2026-10-01 14:33:42 +01:00
Dave Page 25aec55eb2 Parse react-frame-component as CommonJS so 5.3 bundles correctly (#10467)
* Parse react-frame-component as CommonJS so 5.3 bundles correctly

react-frame-component 5.3 added "type": "module" to its package.json
whilst mapping the "require" condition of its exports to a UMD build.
Babel compiles our imports to require(), so webpack resolves the UMD
file and, honouring the package type, parses it as an ES module. With no
exports object in scope, the UMD wrapper falls through to its browser
global branch and the module exports nothing, so <Frame> is undefined.
Opening the Query Tool then throws React error #130 and unmounts the
whole app, which is why every feature test timed out with the 5.3.2
bump in #10460. Node shows the same packaging fault: require() of the
package returns an empty object.

Tell webpack to parse the package as javascript/auto so the UMD takes
its CommonJS branch. Jest is unaffected, as it loads the UMD as CommonJS.

* Bump react-frame-component to 5.3.2.

Take the version the webpack rule exists for in the same change, so CI
exercises the rule against it.
2026-10-01 11:41:47 +01:00
Matt Van Horn c83e0750c4 Explain Docker Compose quoting for PGADMIN_CONFIG_* values in the container docs. #10364 (#10465)
YAML consumes the quotes around a Compose scalar, so a value such as
PGADMIN_CONFIG_MAIL_SERVER: "mail.example.com" reaches config_distro.py
as a bare name and fails with NameError at startup. Document the nested
quoting needed in map syntax and env_file, how the list form differs,
escaping $ as $$, when config_distro.py is regenerated, and add a Compose
example.
2026-10-01 10:10:03 +01:00
Regina Obe 19a41432ac Add support for pg_timetable chains and tasks. #10148 (#10152)
Adds a pgTimeTable Chains node under Servers when pg_timetable is
installed in the maintenance database, with Tasks beneath each chain.
Chains and tasks can be created, edited and deleted, a chain can be
triggered with Run Now, and both have statistics tabs. Includes
regression tests, CI installation of pg_timetable, and documentation.
2026-09-30 17:28:49 +01:00
Guiorgy 7314f5069b Rewrite the container entrypoint using bash features, and pass values to embedded Python safely (#9510)
Reformat pkg/docker/entrypoint.sh to use bash conditionals, arithmetic and
parameter expansion instead of the workarounds needed for BusyBox ash.

The email validation settings and PGADMIN_DEFAULT_EMAIL are now read from
the environment inside Python rather than interpolated into the Python
source, so an address containing an apostrophe works, and a Python error
during validation stops the container instead of passing silently.
2026-09-30 15:58:59 +01:00
耗子andClaude Opus 5.5 5f58828e49 Fix mistranslations in the Chinese (Simplified) translation (#10454)
Correct 162 entries in the zh_Hans_CN catalogue: strings that are wrong
rather than merely worded differently, plus terminology aligned with
the Chinese PostgreSQL documentation.

- Restore the order of positional %s placeholders in three strings.
  The JavaScript gettext fills %s strictly left to right, so the
  reordered translations garbled the update notice, the preference
  load error and the user password length error.
- Keep the half-width colons in ': error: ', which ProcessDetails.jsx
  matches with a regex to highlight error lines, and the SQL comment
  marker in '-- missing definition'.
- Fix strings whose meaning was wrong or reversed, e.g. the ERD drag
  and drop message, relhassubclass, RESTART IDENTITY, ENABLE REPLICA,
  COLLATABLE, CREATE TABLE ... LIKE, and the DBMS Scheduler
  "Schedule" object being called a task.
- Give distinct labels to adjacent fields that shared one, and remove
  leftovers such as "表(s)", "会话token" and an untranslated
  "date/time".
- Use the established Chinese terms where the translation picked the
  wrong sense, e.g. Dependents (previously given the word for
  dependencies), local variables and the package body.
- Follow the terminology of the Chinese PostgreSQL documentation:
  注释 (comment), 字符分类 (LC_CTYPE), 操作符 (operator), 聚簇
  (CLUSTER), 提供者 (provider), 流复制 (streaming replication),
  预备事务 (prepared transaction), 载荷 (NOTIFY payload) and 过滤
  (filter).
- Translate Tab as 标签页 throughout, and the month-day options
  1st-31st as 1 日-31 日.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-30 15:24:11 +01:00
Ian 9d63ea91e2 Preserve database errors from index metadata queries (#10476)
When an index metadata query failed, the Properties and SQL handlers
could replace the original database error with 'string indices must be
integers', or with an error about using a Response as index metadata.
get_column_details() read rset['rows'] before checking the query status,
and get_column_details(), get_include_details() and get_sql() returned
HTTP responses where their callers expect data.

Raise ExecuteError instead, as get_reverse_engineered_sql() already
does, so the original database error reaches the user. Adds regression
tests covering Properties, SQL, modified SQL and update.
2026-09-30 15:23:56 +01:00
dependabot[bot] a0723f9db8 Javascript dependency: Bump brace-expansion in /web (#10479)
Bumps [brace-expansion](https://github.com/juliangruber/brace-expansion) from 1.1.18 to 1.1.21.
- [Release notes](https://github.com/juliangruber/brace-expansion/releases)
- [Commits](https://github.com/juliangruber/brace-expansion/compare/v1.1.18...v1.1.21)

---
updated-dependencies:
- dependency-name: brace-expansion
  dependency-version: 1.1.21
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-30 14:38:42 +01:00
dependabot[bot] 2a65e506a6 Javascript dependency: Bump moment from 2.30.1 to 2.31.0 in /web (#10478)
Bumps [moment](https://github.com/moment/moment) from 2.30.1 to 2.31.0.
- [Release notes](https://github.com/moment/moment/releases)
- [Changelog](https://github.com/moment/moment/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/moment/moment/compare/2.30.1...2.31.0)

---
updated-dependencies:
- dependency-name: moment
  dependency-version: 2.31.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-30 14:38:23 +01:00
dependabot[bot] a100b86ff2 Javascript dependency: Bump ip-address from 10.5.0 to 10.7.1 in /web (#10477)
Bumps [ip-address](https://github.com/beaugunderson/ip-address) from 10.5.0 to 10.7.1.
- [Release notes](https://github.com/beaugunderson/ip-address/releases)
- [Commits](https://github.com/beaugunderson/ip-address/compare/v10.5.0...v10.7.1)

---
updated-dependencies:
- dependency-name: ip-address
  dependency-version: 10.7.1
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-30 14:38:06 +01:00
Sanskar Kharya bdd3282c49 Honour the pgpass file in the Change Server Password dialog (#10451)
The dialog hardcoded the pgpass flag to false, so it always demanded the
current password even when the connection authenticates via a passfile.
Pass the flag from check_pgpass through to the schema instead.

check_pgpass and change_password also disagreed about when a passfile is
in use: the former treated a password entered at connect but not saved
as a passfile connection, which would now disable the Current Password
field whilst the endpoint still required it. Both now use a shared
is_using_passfile() helper.

Fixes #10449
2026-09-30 13:29:14 +01:00
dev-hari-prasad f6a2c1037e Resolve the packaged Electron version from runtime/yarn.lock (#10413)
The Windows, Linux and macOS builds now read the Electron version from
runtime/yarn.lock using 'yarn info electron --json' inside runtime/,
rather than querying the npm registry or using the lower bound of the
range in runtime/package.json. This needs no network access or
node_modules, and packages exactly the version that yarn install
resolves. The build stops with an error if the lockfile is missing or
does not yield a valid version.
2026-09-30 13:27:56 +01:00
dependabot[bot] 3515541320 Javascript dependency: Bump undici from 7.29.0 to 7.30.0 in /runtime (#10471)
Bumps [undici](https://github.com/nodejs/undici) from 7.29.0 to 7.30.0.
- [Release notes](https://github.com/nodejs/undici/releases)
- [Commits](https://github.com/nodejs/undici/compare/v7.29.0...v7.30.0)

---
updated-dependencies:
- dependency-name: undici
  dependency-version: 7.30.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-30 10:35:09 +01:00
dependabot[bot] 369c12c1b2 Javascript dependency: Bump fast-uri from 3.1.6 to 3.1.8 in /web (#10469)
Bumps [fast-uri](https://github.com/fastify/fast-uri) from 3.1.6 to 3.1.8.
- [Release notes](https://github.com/fastify/fast-uri/releases)
- [Commits](https://github.com/fastify/fast-uri/compare/v3.1.6...v3.1.8)

---
updated-dependencies:
- dependency-name: fast-uri
  dependency-version: 3.1.8
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-29 09:24:45 +01:00
dependabot[bot] 88b599e98f Javascript dependency: Bump fast-uri from 3.1.6 to 3.1.8 in /runtime (#10468)
Bumps [fast-uri](https://github.com/fastify/fast-uri) from 3.1.6 to 3.1.8.
- [Release notes](https://github.com/fastify/fast-uri/releases)
- [Commits](https://github.com/fastify/fast-uri/compare/v3.1.6...v3.1.8)

---
updated-dependencies:
- dependency-name: fast-uri
  dependency-version: 3.1.8
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-29 09:24:40 +01:00
dependabot[bot] 4671d2f221 Javascript dependency: Bump electron-context-menu in /runtime (#10457)
Bumps [electron-context-menu](https://github.com/sindresorhus/electron-context-menu) from 4.1.2 to 5.1.0.
- [Release notes](https://github.com/sindresorhus/electron-context-menu/releases)
- [Commits](https://github.com/sindresorhus/electron-context-menu/compare/v4.1.2...v5.1.0)

---
updated-dependencies:
- dependency-name: electron-context-menu
  dependency-version: 5.1.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-28 12:50:32 +01:00
dependabot[bot] 8f487ac666 Javascript dependency: Bump the runtime-javascript-minor-and-patch group (#10456)
Bumps the runtime-javascript-minor-and-patch group in /runtime with 2 updates: [electron](https://github.com/electron/electron) and [eslint](https://github.com/eslint/eslint).


Updates `electron` from 44.4.2 to 44.4.3
- [Release notes](https://github.com/electron/electron/releases)
- [Commits](https://github.com/electron/electron/compare/v44.4.2...v44.4.3)

Updates `eslint` from 10.10.0 to 10.11.0
- [Release notes](https://github.com/eslint/eslint/releases)
- [Commits](https://github.com/eslint/eslint/compare/v10.10.0...v10.11.0)

---
updated-dependencies:
- dependency-name: electron
  dependency-version: 44.4.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: runtime-javascript-minor-and-patch
- dependency-name: eslint
  dependency-version: 10.11.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: runtime-javascript-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-28 12:25:05 +01:00
dependabot[bot] 6e22b29770 Python dependency: Bump psycopg (#10459)
Bumps the regression-python-minor-and-patch group in /web/regression with 1 update: [psycopg](https://github.com/psycopg/psycopg).


Updates `psycopg` from 3.3.5 to 3.3.6
- [Changelog](https://github.com/psycopg/psycopg/blob/master/docs/news.rst)
- [Commits](https://github.com/psycopg/psycopg/compare/3.3.5...3.3.6)

---
updated-dependencies:
- dependency-name: psycopg
  dependency-version: 3.3.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: regression-python-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-28 12:24:53 +01:00
dependabot[bot] ad3ba69ca5 Python dependency: Bump psycopg in the python-minor-and-patch group (#10458)
Bumps the python-minor-and-patch group with 1 update: [psycopg](https://github.com/psycopg/psycopg).


Updates `psycopg` from 3.3.5 to 3.3.6
- [Changelog](https://github.com/psycopg/psycopg/blob/master/docs/news.rst)
- [Commits](https://github.com/psycopg/psycopg/compare/3.3.5...3.3.6)

---
updated-dependencies:
- dependency-name: psycopg
  dependency-version: 3.3.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: python-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-28 12:24:41 +01:00
Dave Page fd7b462f3d Run the scheduled snapshot only on pgadmin-org/pgadmin4 (#10452)
A fork with Actions enabled inherits the nightly schedule but none of the
signing secrets or self-hosted runners, so its snapshot fails at the macOS
certificate import and leaves the Windows job queued for a day. The
location job now skips a scheduled run anywhere else, and every build job
waits on it so that the whole run skips with it. A manual dispatch still
runs anywhere.
2026-09-24 08:04:59 +01:00
Dave Page efa8ac7948 Fix TestHeaderOnLiveLogoutRequest failing in desktop mode
The test asserted that no X-Remote-User header is sent on the request
after a logout, which only holds in server mode. In desktop mode the
before_request hook logs the desktop user straight back in, so the
header is reported again, and every run-python-tests-pg job (which runs
in desktop mode) has failed on it since #10410. Assert the mode-specific
behaviour instead.
2026-09-23 15:05:04 +01:00
Dave Page 0dc122cb2e Sign Windows builds with SHA-256 file digests
The one-step "signtool sign /fd sha256" fails on the build host with
0xc0000225 before the PIN is asked for, because crypt32 converts the
legacy CryptoAPI key handle to a CNG one for SHA-2 digests, and no CNG
provider is registered under the name of Certum's crypto3 CSP. Rebinding
to cryptoCertum3 KSP is not an option, as it cannot see the Common
profile's code-signing key.

signtool's split flow avoids the conversion, so pkg/win32/sign-files.bat
now does the signing in /dg, /ds, /di, timestamp and verify steps, with
one PIN prompt per call as before. Make.bat's :SIGN_FILES and Inno
Setup's SignTool both go through it, the latter via cmd /c.

Also default PGADMIN_SIGNTOOL_DIR to SDK 10.0.26100.0, the one installed
on the host, and match the PIN dialog on "Logowanie do profilu zwyk" so
that a Secure profile prompt is never answered with the Common PIN.
SIGNING.md gains the full setup procedure, the root cause and the split
signing flow.
2026-09-23 14:10:10 +01:00
Dave Page c8ae16d13f Document adding and retiring Linux build platforms
A new Debian, Ubuntu, Fedora or EL release is named in seven places across
the build matrices, the snapshot and release workflows, the acceptance tests
and the publishing wrapper, and missing the wrapper leaves the packages built
and uploaded but never indexed. pkg/linux/PLATFORMS.md lists them all, with
the steps for adding a platform, retiring one and the server-side follow-up.

The platform lists in the Debian and Red Hat READMEs had drifted (Ubuntu
25.04, Fedora 40 and 41, RHEL 8), so they now point at the build matrices
instead.
2026-09-23 10:53:09 +01:00
Dave Page dd0d8ac533 Revert Windows code signing to SHA-1 file digests
#10355 moved signtool to /fd sha256 on the assumption that the key
provider repair described in pkg/win32/SIGNING.md made SHA-256 possible.
It does not: that repair binds the certificate to the Certum card's
legacy CryptoAPI provider, crypto3 CSP, which fails a SHA-256 file digest
in SignerSign() with 0xc0000225 before the PIN is requested, whilst
/fd sha1 signs and verifies. SHA-1 is what every previous release has
shipped with, so go back to it for both the component and the installer
signatures, and document why.

The timestamp digest stays at SHA-256, which works. Rebinding the
certificate to Certum's CNG provider is the likely route to SHA-256 file
digests, but is untested and is left for later.
2026-09-23 10:26:37 +01:00
Dave Page d0315c58ec Fix the Windows environment check, which cmd could not parse
The messages that report a missing prerequisite were changed from !VAR!
to %VAR% in commit afa0c773a, since the file does not enable delayed
expansion and they printed the variable name rather than the path. That
made them correct and unparseable at the same time: cmd expands %VAR%
when it parses a parenthesised block rather than when it runs it, and
PGADMIN_INNOTOOL_DIR defaults to "C:\Program Files (x86)\Inno Setup 6",
whose closing parenthesis then ended the IF block early. Every Windows
build has failed at "Checking the environment..." since, with "\Inno was
unexpected at this time", whether or not Inno Setup was installed, which
took the nightly snapshot with it.

The four checks move into a :REQUIRE_DIR subroutine that takes the
directory and the hint, and echoes both outside any block, where a
parenthesis is just a character. Enabling delayed expansion would also
have worked, but only by making ! a metacharacter for the whole file.
The other uses of these two paths are all inside double quotes, which
the parser does respect, so they were never affected.
2026-09-23 09:01:54 +01:00
Dave Page 43d8b3fabf Rename the server 'Change Password' option to 'Change Server Password' (#10035)
The 'Change Password...' option on a server node was ambiguous, because it
changes the password of the PostgreSQL role that pgAdmin connects with, yet
read as though it might change the pgAdmin login password instead. The menu
option and its dialog are now called 'Change Server Password', with the
connected role name in the dialog title, and the equivalent option in the
user menu becomes 'Change pgAdmin Password', so that the two can no longer
be confused with one another.

The dialog's own 'User' field was always blank, since the userName prop that
showChangeServerPassword passes was never accepted by ChangePasswordContent;
it is now wired through, which also makes the existing documentation of that
field accurate. The documentation for both dialogs has been updated to match
the new names, along with a couple of button names that had drifted.

Fixes #9230.
2026-09-22 17:15:12 +01:00
dev-hari-prasad e78c7fe020 Fix Query Tool tabs auto-running their query after a session restore (#10055)
Typing in the editor of a View/Edit Data tab promotes it to a Query Tool, but
that promotion only ever updated the component's own state: the tab's saved
metadata kept the original tool URL, with is_query_tool=false in its query
string. On the next start-up the tab was therefore restored as a View/Edit Data
tab, and View/Edit Data tabs execute their query as soon as the connection is
made, so whatever SQL the user had left in the editor ran unprompted. A
restored DELETE or UPDATE running by itself is not a pleasant way to start the
day.

toggleQueryTool now rewrites is_query_tool in the panel's stored toolUrl and
saves the layout, so a promoted tab comes back as a Query Tool and no longer
takes the auto-execute path. The URL is kept relative, because in Desktop mode
the runtime picks a fresh port on every launch and an absolute URL would point
the restored tab at a dead origin.

is_query_tool and restore are also normalised to real booleans up front rather
than compared against the string 'true' in each place they are read, and a
failed restore no longer leaves the editor disabled with nothing logged.

Fixes #10031
2026-09-22 17:11:02 +01:00
Dave Page 2ba68de777 Add Caddy reverse proxy configuration examples (#10344)
Adds Caddy examples alongside the existing NGINX ones for hosting pgAdmin with
Gunicorn or uWSGI, both at the root of a server and under a sub-directory,
mirroring the structure of the NGINX sections. Caddy does not speak the native
uwsgi protocol, so its uWSGI examples run uWSGI in HTTP mode instead.

Documents the two things that must line up for a sub-directory deployment
behind any reverse proxy: the proxy forwarding the request path unmodified
with an X-Script-Name header, and a SCRIPT_NAME environment variable on the
pgAdmin process itself, which is read at startup to set APPLICATION_ROOT and
SESSION_COOKIE_PATH. The missing environment variable is what caused the
"login succeeds then bounces back to the login page" report in #10334.

Also notes that pgAdmin trusts X-Script-Name and X-Scheme unconditionally,
unlike the X-Forwarded-* headers, so every example now either overwrites or
clears both rather than passing on whatever the client sent; warns that the
systemd unit shipped with Caddy sets PrivateTmp=true, which hides a socket
created in the system /tmp; and refreshes the stale python3.7 paths.
2026-09-22 17:03:47 +01:00
Dave Page afa0c773ad Sign the bundled PostgreSQL binaries in the Windows build (#10355)
The PostgreSQL and Kerberos utilities and libraries we ship in the
Windows package are not signed, whilst the installer, the uninstaller
and pgAdmin4.exe are. Nothing verifies an Authenticode signature when
these run, so this is not a security fix, but it does make life easier
for organisations running application allow-listing under WDAC or
AppLocker, where publisher rules are simpler and more durable than path
or hash based ones, and it cuts down on antivirus false positives.

The signtool invocation moves into a :SIGN_FILES subroutine, and a new
:SIGN_COMPONENTS step signs everything we build ourselves once
:CREATE_RUNTIME_ENV has staged it. Names are matched through DIR /B so
the optional libraries are skipped when absent, and the whole thing is a
no-op when PGADMIN_WINDOWS_CSC is unset, so unsigned developer builds
are unaffected. The Electron, Python and VC++ runtime components are
deliberately left alone, being third party binaries whose own signatures
ours would replace. Everything goes through a single signtool call,
since the hardware token prompts for a PIN on the first signature of a
session.

The file digest moves from SHA-1 to SHA-256 for both the runtime and the
installer. SHA-1 was never a deliberate choice: it dates from the move
to the Certum token, at a point where the certificate in the machine
store had no key provider link, which limits signing to SHA-1. The
buildfarm now repairs that link with certutil when it provisions the
host.

The four optional PostgreSQL libraries were copied without checking the
result; they now abort the build like the others do.

PGADMIN_POSTGRES_DIR and PGADMIN_KRB5_DIR defaulted to an EDB PostgreSQL
installation and an MIT Kerberos for Windows installation respectively,
whereas both sets of binaries have come from winpgbuild for some time
and the buildfarm points at C:\build64\postgresql and C:\build64\krb5.
The four "does not exist" messages that report a missing prerequisite
used !VAR!, but the SETLOCAL at the top of the file does not enable
delayed expansion, so they printed the variable name rather than the
path that was looked for.

Finally, the acceptance test now verifies the signatures on everything
:SIGN_COMPONENTS signs, walking the same list of names where the files
land: none of them exist outside the installer until the installer has
run, so that is the only place a published build can be checked. The
expected publisher is taken from the installer itself rather than hard
coded, so a component signed by somebody else is caught without the
workflow needing an edit when the certificate is renewed.
2026-09-22 17:02:38 +01:00
dev-hari-prasad 351376af7f Enforce --immutable on every yarn install, in CI and the release builds (#10389)
In the four GitHub Actions workflows the flag is documentation only, since
Yarn's enableImmutableInstalls already defaults to true whenever CI is set in
the environment, but making it explicit means the intent is visible in the
workflow rather than implied by the runner.

The six installs that run outside CI are where this actually changes
behaviour: the Makefile, the Dockerfile, and the pip, Linux, macOS and Windows
packaging builds all run with yarn.lock beside them, and until now any of them
would quietly rewrite the lockfile rather than fail. A release build that
rewrites the lockfile is shipping something other than what we reviewed, so
failing loudly there is the point of the exercise.
2026-09-22 16:50:39 +01:00
Domenico Sgarbossa 91e7747226 Updated message catalogs for v9.18 (#10448) 2026-09-22 16:43:37 +01:00
Dave Page 84a76baa8e Pin against pgbuild's immutable releases, now that they exist
The lock was written against the rolling tags because the per-version
releases did not exist when it was generated, and the refresh tool assumed
PostgreSQL was tagged by major, which it is not: the release that never
changes is postgresql-18.6, whilst only the rolling one says 18. The tool
now resolves a major to the version pgbuild's manifest names, and a tag that
does not exist is an error rather than something to fall back from, since a
lock recording an archive nobody can fetch is worse than no lock at all.
2026-09-22 16:17:05 +01:00
Dave Page c603393827 Run the Windows and macOS build checks when the dependency lock changes
A lock change decides which PostgreSQL, OpenSSL and Kerberos binaries end up
inside the installer, so it is exactly the kind of change those checks exist
for, and without this it was the one packaging input that could move without
either of them running.
2026-09-22 14:31:45 +01:00
Dave Page ce6c049dbc Pin and verify the pgbuild build dependencies
The install-pgbuild-deps action fetched PostgreSQL, OpenSSL, Kerberos, zstd
and lz4 from pgbuild release tags ending in -latest, whose assets are
replaced in place on every rebuild, and unpacked them with no checksum or
signature check anywhere in between. Since the resulting build is
Authenticode signed on Windows and Developer ID signed and notarised on
macOS, that made write access to pgbuild equivalent to write access to what
pgAdmin ships, and it meant a build was not reproducible either, the same
commit producing different binaries depending on the day it was built. This
is pgadmin-org/pgbuild issue 1.

pkg/pgbuild-deps.lock now records, for every dependency the action can
fetch on either macOS architecture and on Windows, the per-version release
tag to download from and the SHA-256 its archive must hash to. The action
fetches that tag, checks the digest before unpacking, and fails on a
mismatch or on a dependency the lock does not mention, since an unpinned
dependency reaching a signing build is the thing this is meant to prevent.
pgbuild publishes a .sha256 beside each archive, which is deliberately not
consulted: whoever rebuilds an archive rebuilds that too, so the lock is
the only thing here that pins anything.

Being out of date is a different matter from being wrong, so once an
archive is verified the action asks pgbuild what it has published since,
and warns rather than fails when the pinned build is no longer the newest.
That check is best effort and never fails a build whose downloads have
already been verified.

tools/refresh_pgbuild_lock.py rewrites the lock, taking the version to pin
from pgbuild's own manifest.json and working one package at a time so that
bumping OpenSSL does not restate every other digest. The diff it produces,
with the upstream version visible in the tag column, is the audit trail the
previous arrangement had none of.

The digests were taken from the archives pgbuild publishes today, which are
the same archives its per-version releases will carry, but those releases
do not exist yet, so the tags in the lock cannot be fetched until pgbuild's
own change lands.
2026-09-22 14:30:43 +01:00
Dave Page bccef24bf7 Drop from= from the authorized_keys templates, which do not carry it
The deployed files are generated rather than hand written, and that option is
not one we can set there, so the templates described a restriction production
does not have. What a key may do is still bounded by restrict and the forced
command, which is the part that matters; what is lost is the second answer to
where it may be used from.
2026-09-22 13:07:19 +01:00
Dave Page e543aaa6f9 Bring install-repo-readme.py up to the project's pep8 settings
It has been failing check-python-style since it landed: five lines over the
limit, and two breaks before a binary operator, which count here because
.pycodestyle sets an explicit ignore list and so loses pycodestyle's own
default exemption for W503.
2026-09-22 11:40:50 +01:00
Dave Page 720dd3714f Ship the docs tarball with its versioned directory, as releases always have
The web server unpacks this into the documentation root and then hands
docloader the directory name pgadmin4-<version>-docs, so a flat archive would
have scattered several hundred HTML files across that root and then failed on
a directory that was never created. Every published tarball carries that top
level; the one assembled here did not, and the first release to notice would
have been the next one.
2026-09-22 11:25:32 +01:00
Dave Page af5fd2acc3 Move the archive sync and release purge scripts into the publishing tooling
sync-ftp-to-s3.py and purge_pgadmin_releases.sh have been living in the
pgaweb checkout under tools/, which was never where they belonged: neither
touches Django, the site database or Varnish, and both work on the download
tree at /var/ftp/pgadmin4, so they are part of publishing rather than part of
the website. They move here, renamed to match the hyphenated names of the
scripts already in this directory, and the README gains them in the file
table, in the install line and in the prose that explains what lives where.

The sync-s3 verb now runs sync-ftp-to-s3.py out of PUBLISH_DIR instead of
TOOLS_DIR, which makes this a deployment-ordering change: the wrapper and the
copy of the script it names must both be installed on the download server
before the pgaweb side deletes its own copy, and the comment on the verb says
so. The three verbs that remain genuinely website operations, create-release,
load-docs and purge-cache, still reach into TOOLS_DIR and are untouched.

purge-pgadmin-releases.sh deliberately gets no verb. It is a by-hand
operation that deletes published content, it defaults to a dry run that
somebody is expected to read before re-running with --live, and the rebuild
scripts it pairs with are already documented as standalone; handing a
compromised runner the ability to delete releases would undo most of what the
wrapper is for.

Both scripts are otherwise unchanged apart from the filename in the purge
script's own header comment, and four lines in the Python rewrapped to 79
columns because pkg/ is covered by check-pep8 and the originals were not.
2026-09-22 11:19:39 +01:00
Dave Page 2343f60f04 Select the publishing runner by role rather than by its hostname
The runner has carried both labels all along, so this is the last of the
machine names out of the tree; roadie can stay on the runner until these have
run green, and then go.
2026-09-22 11:06:25 +01:00
Dave Page 5f102aa36c Do not claim the PIN helper was shipped as a compiled executable 2026-09-22 11:03:40 +01:00
Dave Page 1b392caa0f Say how the PIN helper is installed and started
The section named the script and left the reader to work out the rest: where
AutoHotkey comes from, where the script should live given the runner deletes
its own workspace, how it starts in the interactive session alongside the
runner, and how to tell whether it is running at all.
2026-09-22 10:46:59 +01:00
Dave Page 8bca7e0c57 Retry the notarisation wait rather than failing the build
xcrun notarytool wait polls Apple for as long as the notarisation takes, and
exits non-zero if any single poll fails, so a runner losing its route for a few
seconds failed a notarisation that was proceeding perfectly well: the 22nd
September snapshot died twenty six minutes into waiting for a DMG Apple had
already accepted, with "The Internet connection appears to be offline".

The wait is now retried ten times at a minute apart, without resubmitting,
since the submission is still queued under the same ID. Each failure asks for
the status directly, because the wait also exits non-zero when a submission
genuinely ends as Invalid or Rejected, and any terminal status ends the loop
and leaves the existing check to decide what it means.
2026-09-22 10:40:08 +01:00
Dave Page 475b864e7f Stop the publishing pipeline overwriting what it has already published
Every one of these is a way that a verb meant only to add something would
quietly change something already published, which is the failure the wrapper
exists to prevent, so they are worth having together.

Snapshot retention kept the newest five directories, and a directory is
something either key can create: five dated today with high suffixes filled
the keep set and every genuine snapshot was deleted. It now keeps every
directory whose date is among the newest five that are not in the future, so
retention is counted in days, and the intended consequence is that a day with
several builds keeps all of them.

release-fetch required only that v<VERSION> existed, and shutil.move onto an
existing file replaces it, so a release published months ago could be
overwritten and autoupdate-publish and sync-s3 would then carry the
replacement to the auto-updater and into an archive that has no undo. The
single-shot guarantee that release-create made for the first verb now covers
the whole sequence: it refuses before moving anything if .incoming exists or
if a content directory holds more than its maintainer marker, and refuses each
individual move whose destination is already there.

packages-fetch pulled with no --ignore-existing, so a staging package whose
filename matched a published one replaced it and the following rebuild signed
the new bytes. It now leaves the live copy alone and reports what it skipped,
since a collision during a real promotion means two builds have produced one
filename.

autoupdate-publish deleted the live archives before moving the new ones in,
which left a window with nothing there at all; the order is reversed and only
archives this release did not replace are removed, and once every move has
succeeded. --delay-updates leaves .~tmp~ behind in the live trees when a
transfer is interrupted, and both indexers descend into it, so the holding
directories are swept immediately before indexing rather than moved out of the
tree with --partial-dir, which would make the final rename a copy across
filesystems. DATESTAMP_RE and VERSION_RE gain re.ASCII, because \d matches any
Unicode decimal digit and int() parses those, so a fullwidth datestamp on the
filesystem read back as an ordinary date.

In the workflows, the repository variables naming the SSH target and the key
paths reached option positions, as the first positional argument to ssh and
inside the -e string rsync splits on whitespace. Only an administrator can set
those, so this is defence in depth: they are validated against a conservative
pattern in the step that already checks the keys are present, and the target
is passed after --. snapshot.yml passed the raw inputs.location to its publish
step rather than the validated output of the location job, which agreed only
by coincidence, and it now carries a flag for whether a location was named so
that an empty input still means the assembled directory name.
check-container-build.yml gains the top-level permissions: contents: read the
other workflows have, leaving the publish job's packages: write alone, and
promote-release.yml verifies the wheel's detached signature against the
published signing key before uploading it to PyPI, the mirror having been
trusted on TLS alone until now.

The README and the download server's key annotations are updated to match: the
guarantees they stated about single-shot publication and about retention were
overstated, and are now true.
2026-09-22 10:31:40 +01:00
Dave Page d04e39cc65 Describe the signing host without naming whose rack it is in 2026-09-22 10:24:53 +01:00
Dave Page b7789be4af Bring the Certum PIN handler into the repository
The script that answers the signing card's PIN prompt lived only in the
buildfarm repository, as an Ansible template with the PIN itself interpolated
into it. That repository is going away, and the template could not come with it
as it stood, so this is the same script with the secret taken out and the two
faults that cost a build this morning fixed.

The PIN now comes from a file in the build user's local application data, read
once at startup, so neither this repository nor the compiled executable carries
it; the helper says so and exits if the file is missing or empty, rather than
sitting in the tray looking healthy whilst answering nothing.

The build was lost to a race. The original waited for the dialog and then
activated it as two separate operations, and when the activate lost that race
and threw "Target window not found", AutoHotkey put up its default error dialog
on a machine with nobody to dismiss it, so one transient fault became an
indefinite hang. So the work now happens on a timer rather than in a loop that
can end, activation is retried for a couple of seconds and addressed by window
handle rather than by title, a window that vanishes mid-operation is a log line
and a return rather than an error, and an OnError handler makes it impossible
for anything to put a dialog on the screen at all.

Whilst there, the PIN is sent with SendText rather than Send, which would have
read {, +, ^, ! and # in it as modifiers, and it is only sent once WinActive
confirms the card's own dialog has the focus, because a blind send on a build
machine is a good way to type a PIN into a console whose output gets uploaded.
The title is matched on its leading unaccented substring, which keeps the file
to plain ASCII and survives proCertum wording changes.

SIGNING.md gains the operator's half of that: where the PIN file goes, the
icacls to lock it down, where the log is, and what each thing the log can say
means when a signed build hangs.
2026-09-22 10:24:02 +01:00
Dave Page 97a7e55b96 Close the review's remaining findings in the workflows
The promotion validated its inputs in the promote job, which the registries
scope skips, so under that scope the typed-twice confirmation did not cover
the step that moves the latest tag; validation moves to a job both paths
depend on. The container tag loops no longer glob against the workspace, and
check-container-build validates the location it interpolates into a push tag
in a job holding the Docker Hub credentials.

The acceptance test built its apt sources line with sh -c, which re-parsed the
expanded base URL as source: the one place in the pipeline where a
caller-supplied value reached a shell. The outer shell writes the file now,
and the URL is checked once, against a host allowlist, before any job
downloads and installs what that host serves as root.

The actions in jobs holding registry or trusted-publishing credentials are
pinned by commit rather than by a movable tag, as the SonarQube action already
was, and so is the helm installer piped into a shell beside them.

Also: the README understated the signing verbs, which select by extension
across the tree rather than by anything tied to a build.
2026-09-22 10:00:17 +01:00
Dave Page ff9819e222 Make snapshot retention safe, and stop packages-fetch importing staging's indices
snapshot-purge sorted directory names and kept the last five, so a name that
merely sorted late survived and everything real fell off the end: five
snapshot-create calls with a future datestamp, which the verb accepts up to
two days ahead, were enough to have the next purge delete every genuine
snapshot. Anything dated after today is now left out of the retention set
entirely, and the ordering is by date and then by suffix as a number, which
also fixes 2026-09-22-10 sorting before 2026-09-22-2 and so a day with more
than nine builds keeping the older ones.

packages-fetch pulled staging's Packages files and repodata into the live
tree, whilst the signed Release, Release.gpg and InRelease they are checked
against live a directory further up and were left as they were. Every live
apt repository therefore failed on a hash sum mismatch from the moment the
fetch landed until that codename's rebuild caught up, which with five
sequential rebuilds each taking the lock is minutes. The docstring already
claimed the indices were left behind; now they are.

The pull key is renamed to pga-pull to match the other two.
2026-09-22 09:58:02 +01:00
Dave Page 355d6d099f Name the publishing hosts by role rather than by hostname
The machine names were only ever in comments and two filenames, but the
repository is public and the buildfarm never was, so there is no reason to hand
a reader the mapping from internal name to public service. The two
authorized_keys templates become .staging and .download, and the prose refers
to the staging server, the download server and the runner.

The pull key the download server uses is renamed to match, so it needs moving
on that host: ~pgaupload/.ssh/id_ed25519_paxsor_pull -> id_ed25519_pull. The
runner's own key paths come from repository variables, so the defaults here
changing affects nothing.
2026-09-22 09:49:07 +01:00
Dave Page da0bc3ecd9 Say which platforms read pkg/python-version.txt
Only the Windows and macOS packaging does, those being the two that ship an
interpreter; the Linux packages use the distribution's Python.
2026-09-22 09:38:49 +01:00
Dave Page db2030e9c0 Describe where aptftp.conf lives rather than telling the reader to move it 2026-09-22 09:23:31 +01:00
Dave Page 34cb0be9a2 Make a scheduled snapshot actually publish
Both publishing steps were gated on inputs.publish, which exists so that a
dispatched test run builds without uploading. A schedule event carries no
inputs, so that expression was null rather than false and the nightly built
everything, assembled the tree and threw it away, reporting success. Publish
unconditionally on a schedule, and keep the input for dispatches.
2026-09-22 09:06:35 +01:00
Dave Page ca275cbc8d Let the registry half of a promotion be rehearsed on its own
The container re-tag and the chart push need no download server and touch
nothing that cannot be deleted, but they were reachable only through a real
promotion, which is the one thing we cannot practise. A "registries" scope
skips the promote job entirely and runs just those two, leaving the PyPI
upload out since a rehearsal has no published wheel to upload.
2026-09-21 21:49:13 +01:00
Dave Page c28362013f Give the container publish its own job, on the publishing environment
The Docker Hub credentials are environment secrets, and an environment
secret is not available to a job that does not name the environment.
secrets: inherit passes repository secrets, so the login failed with
'Username and password required' and would have done the same in a real
candidate run.

Splitting it also keeps the credentials away from the build check, which
runs on every pull request and has no business being able to push.
2026-09-21 16:26:02 +01:00
Dave Page b2d1362b8a Let the container build be dispatched with its publish inputs
They were only on workflow_call, so the push path could not be exercised
without running an entire release candidate to reach it.
2026-09-21 16:24:51 +01:00
Dave Page 24a1f24e48 Add a button for purging the website cache
The last thing in the release process still needing Jenkins. Promotion
purges the cache, but the website edits that follow a release happen
afterwards and are all cached, so there has to be a way to purge it on
its own.

No arguments: the verb behind it clears everything, and there is nothing
for a caller to choose.
2026-09-21 16:11:13 +01:00
Dave Page e1915c7dc0 Publish the container, chart and wheel from Actions
The last three things still running from Jenkins, and the reason the
buildfarm could not be switched off.

The container is built for both architectures and pushed under the
candidate's location, then re-tagged at promotion with buildx imagetools
rather than rebuilt, so what ships is the manifest the acceptance test
ran against. It goes to Docker Hub and to GHCR: Docker Hub stays
canonical because every tutorial and compose file in the world names
dpage/pgadmin4, whilst GHCR is organisation owned, needs no stored
credential and is not subject to Docker Hub's anonymous pull limits.

The Helm chart moves to GHCR outright. Its version comes from Chart.yaml
so there is no candidate copy to re-tag, its install base is a fraction
of the container's, and oci://docker.io/dpage was an odd home for a
chart.

The wheel is fetched from the published release rather than rebuilt, so
what reaches PyPI is the file the acceptance test installed, and it goes
up by trusted publishing, which exchanges the workflow's own identity for
a short-lived credential rather than holding an API token.

All three run in their own job on a hosted runner. They need none of the
publishing keys, so the machine that holds those never handles registry
credentials, and a registry outage cannot leave a half-finished
promotion on the download server.
2026-09-21 16:10:13 +01:00
Dave Page 89bb92dc44 Read the staging server's name from the server
It was the last SITE value the repository had to get right, and it was a
fully qualified internal hostname in a public tree.

It is read here rather than accepted from the caller, which is the part
that matters: the client names a verb and a datestamp and never a host,
a path, a binary or a signing key, and that is what stops a compromised
runner asking for a signature over something it fetched from a source of
its own choosing. A workflow variable would put it on the wrong side of
that line. It is validated as a hostname on the way in, since it becomes
part of an rsync remote specification.
2026-09-21 15:35:59 +01:00
Dave Page 42d2e55bcd Write the maintainer marker into published directories
Every directory under a release carries a CURRENT_MAINTAINER naming the
support address, which the PostgreSQL mirror network expects and which
the buildfarm wrote with an echo in each of nine job definitions. The
rehearsal produced a release directory without them.

It is a file beside the scripts now, so changing the support address is
one reviewed commit.
2026-09-21 15:30:49 +01:00
Dave Page f57e46c7c4 Fetch the release downloads, and keep the rehearsal confined
Two faults the first working rehearsal exposed.

rsync without -r reports 'skipping directory .' and transfers nothing,
so release-fetch created the directory, sorted no files and reported
success. The comment claiming -r was omitted on purpose was simply
wrong; the trees are excluded by pattern instead.

The auto-updater archives were being moved by release-fetch, which
writes them outside v<VERSION>. That contradicted the whole point of the
release-directory scope, which is that deleting one directory undoes it.
They are now autoupdate-publish's job, and it runs with the packages,
where the promotion stops being reversible anyway.
2026-09-21 15:28:58 +01:00
Dave Page 9a68105260 Name the staging server in full
PULL_HOST carried the short name, one of the SITE values never confirmed
against the servers, and the first real release-fetch failed on it. The
firewall now permits the pull and the host key is recorded on the
download server under both names; the fully qualified one is used here so
that what this file names and what known_hosts records cannot drift.
2026-09-21 15:27:06 +01:00
Dave Page 299a767b1f Make the promotion scope an explicit choice
Three settings rather than a boolean, because the steps differ in how
undoable they are and that is what somebody needs to choose between.

release-directory writes only /var/ftp/pgadmin4/v<VERSION>, so deleting
that directory undoes it completely; it is the only setting that leaves
the live repositories alone, and so the only one that can be rehearsed.
files goes on to copy packages into the production trees and re-sign
every index clients read. everything adds the website and the S3
archive, neither of which can be undone.

The default is the safe one, on the grounds that a full promotion should
be a deliberate choice rather than what happens if nobody reads the
form.
2026-09-21 15:09:03 +01:00
Dave Page fc6815ae70 Allow a promotion to stop after the files
The website update and the S3 archive are the two steps with no undo:
one writes to the website database, the other copies into a bucket whose
sync carries no --delete. files-only skips both, so a promotion can be
rehearsed against a throwaway version and the files deleted again before
the hourly sync carries them to the mirrors.
2026-09-21 15:06:24 +01:00
Dave Page 456b2ddefa Promote a tested candidate to the download server
The last piece, replacing pgadmin4-all-publish-qa-to-prod and the deb
and rpm promotion jobs, plus update-download-archive and
pgadmin4-website-create-release.

It builds nothing. It takes a candidate that already exists on the
development server, having been built, signed, indexed and installed
from by the acceptance test, and moves it across: the release directory,
the downloads sorted into it, the packages into the live repository
trees, then the indices, the READMEs, the website and finally the S3
archive. The order is deliberate, since an interruption before the
indices leaves packages nothing points at, which is recoverable, whereas
the reverse is a repository describing packages that are not there.

Two changes to the wrapper it depends on.

release-fetch assumed the staging build was divided into docs, macos,
pip, source and windows. It is not: a staging build is flat, and it is
promotion that sorts the downloads into those directories, which the
buildfarm did with a series of scp commands carrying shell globs. That
sorting is now a table, the destination comes from each file's own name,
and an unrecognised file stops the publication rather than being dropped
silently. It also handles the auto-updater ZIPs, which replace the
previous release's rather than accumulating beside them, and which
nothing here had carried across at all.

rebuild-readme is new, and closes the gap left when the README generator
went in: nothing regenerated the production platform tables, only the
staging and snapshot ones. Those carry the release history, so they
change with every release.
2026-09-21 15:04:21 +01:00
Dave Page 9039065ee0 Check Gatekeeper before codesign --strict on the disk image
The macOS jobs failed on 'Disallowed xattr com.apple.FinderInfo', which
is not a signature problem: _create_dmg runs SetFile -a E on the bundle
to hide the .app extension in the disk image window, and that writes the
attribute --strict refuses to see.

What decides whether a user can open the application is Gatekeeper, so
spctl and stapler run first and are the pass or fail. --strict still
runs, and reports rather than fails, so that a future signature problem
is still visible and distinguishable from the attribute we put there
deliberately.
2026-09-21 14:53:08 +01:00
Dave Page 620f7b8064 Check the Windows, macOS and direct downloads too
The apt and yum halves proved a user can install from the repositories.
These cover everything else a user can download.

Windows is the most valuable, because it closes a gap rather than
confirming something already checked: nothing had ever run the installer,
and nothing verified the Authenticode signature on the pgAdmin4.exe
inside it. Make.bat's own check tested a stale %ERRORLEVEL%, and the
workflow step that claimed to cover it re-verified the installer instead.
That binary does not exist outside the installer until the installer has
run, so this is the only place it can be verified.

macOS mounts the published disk image rather than inspecting the bundle
that was just built, with the quarantine attribute a browser would set so
Gatekeeper is actually consulted. It also runs otool over the bundled
client binaries and fails if any still points at /opt/pgbuild, Homebrew
or /usr/local, which is what a dependency that was linked but not
relocated looks like.

The rest is deliberately shallow: the wheel is installed into a venv and
imported, the tarballs are checked for a couple of known paths, the PDF
and ePub are checked to be those formats and not truncated, and every
detached signature is verified from the published URL rather than on the
server, since that is the copy a user actually fetches.
2026-09-21 14:48:54 +01:00
Dave Page 3cd04b405e Do not use grep -q under pipefail
Both halves installed correctly and then failed the assertion that they
had: grep -q exits on the first match, dpkg -L and rpm -ql die of
SIGPIPE, and pipefail reports the pipeline as failed. The packages do
ship files under /usr/pgadmin4, as dpkg-deb -c on the published .deb
confirms.
2026-09-21 14:43:08 +01:00
Dave Page 8057624259 Correct two faults in the acceptance test itself
setup-web.sh ships in pgadmin4-web, not pgadmin4-server, so the apt jobs
installed correctly and then failed on an assertion about a file that
package never contained. The check is now that the package delivered
files under /usr/pgadmin4, which cannot be wrong about which package
owns what.

The yum jobs never got as far as installing: dnf install curl conflicts
with the curl-minimal already in those images, and curl was not needed
in the first place.
2026-09-21 14:40:47 +01:00
Dave Page 750d0630e0 Run the acceptance test steps under bash
The containers default to sh, which has no pipefail, so every step died
on its first line with 'Illegal option -o pipefail' before testing
anything.
2026-09-21 14:38:16 +01:00
Dave Page c23172af37 Install from the candidate, as a user would
Everything else checks that files exist, that indexes parse and that
signatures validate. All three can be true of a repository apt still
refuses, and both bugs the migration turned up were that shape: packages
one directory too deep, and noarch RPMs filed where no dnf client looks.
Neither failed a build.

So this inspects nothing. It follows the instructions in the repository
README, in a clean container, on all five apt platforms and all four yum
ones, and installs the package. No --allow-unauthenticated, no
--nogpgcheck, no pinning, so a wrong signature or an architecture missing
from Release fails the job.

It runs against a candidate rather than a snapshot because the
development server publishes its tree immediately, whilst the download
server sits behind an hourly sync to the mirrors that would otherwise be
most of what the test measured.

Promotion stays a human decision, so this gates nothing automatically; a
red result is simply a candidate that must not be promoted.
2026-09-21 14:36:09 +01:00
Dave Page 458b24b5f8 Do not write a literal ${{ }} in a comment
GitHub evaluates workflow expressions inside run blocks before the shell
sees them, comments included, so an empty one is a parse error: the
whole file is rejected with 'An expression was expected' and the
workflow cannot be dispatched or scheduled at all.

snapshot.yml has carried this since the review fixes landed, which would
have failed tonight's nightly, and release-candidate.yml inherited it.
2026-09-21 14:32:45 +01:00
Dave Page 4dc7a7bd7b Add release candidate builds, publishing to the development server
Phase one of moving the release pipeline off the buildfarm, replacing
the pgadmin4-*-build jobs. The same builds as the nightly snapshot,
calling the same workflows, but published to procyon through the
wrapper's staging verbs rather than to the download server.

The difference is what the tree is for. A snapshot is finished when it
is published; a candidate is published so that it can be tested, and
promoted afterwards. developer.pgadmin.org serves the staging tree over
HTTP the moment it is written, so a candidate's repositories can be
added and installed from immediately, whereas the download server sits
behind an hourly sync to the mirrors.

Never scheduled, and publishing is off unless asked for, because a
candidate exists only because somebody decided to make one.

Needs a STAGING_SSH_TARGET variable on the publishing environment; the
keys and the wrapper are already deployed on procyon.
2026-09-21 14:32:45 +01:00
Regina Obe 6312baa34e Fix dynamic type function not receiving correct state for collection row fields (#10398)
When a schema field uses a dynamic type function (type as a function)
and is rendered inside a collection (e.g. chain tasks), the function
always received the top-level schema data instead of the row-level
data. This caused the field to fall through to its default type,
ignoring the actual field values in the row.

Resolve the type callback's state against the field's own container
instead, mirroring what cell() already gets via its row argument: for a
field inside a collection row that is the row, and for a top-level
field the parent path is empty, so the whole schema data comes back as
before. Nested tabs and fieldsets carry no id, so they do not extend
the access path and are unaffected.

As well as the pg_timetable case that prompted this, it repairs the
expanded-row Definition forms that were already relying on row state
and silently getting the table's: the foreign key 'Referencing'
column list, the partition name control's attach/create switch, and
the column dialog's identity/generated constraint options.
2026-09-21 13:15:33 +01:00
Hari Prasad 5f56805162 Stop the Query Tool spinner whilst a password prompt is open (#10436)
When restoring saved Query Tool tabs, or switching to a connection with no
saved password, the backend replies with HTTP 428 and the 'Connect to server'
dialog opens, but obtaining_conn was left set to true whilst waiting for the
user. ConnectionBar renders MUI's CircularProgress from that flag, so every
affected tab kept two infinite CSS animations running at the display refresh
rate, costing around 30-35% CPU whilst completely idle.

obtaining_conn is now cleared when the 428 arrives and set again only whilst a
connection request is actually in flight, with a promptCallback threaded
through connectServer() so that password retries behave the same way. Along the
way this also fixes cancellation leaving obtaining_conn stuck on with the
Promise never settling, the New Connection dialog closing itself on a failed
connection rather than reporting the error, and duplicate entries being added
to the connection list when a role was an empty string rather than null.

Fixes #10386
2026-09-21 13:15:03 +01:00
Dave Page 7242be8be6 Do not write a literal ${{ }} in a comment
GitHub evaluates workflow expressions inside run blocks before the shell
sees them, comments included, so an empty one is a parse error: the file
is rejected with 'An expression was expected' and the workflow cannot be
dispatched or scheduled at all. Tonight's nightly would not have run.
2026-09-21 13:01:42 +01:00
dependabot[bot] e419d45930 Javascript dependency: bump html-react-parser from 5.2.17 to 6.1.7 in /web (#10336)
html-react-parser 6 is ESM only, and although webpack handles that without
complaint, Jest runs the suite as CommonJS and only transforms the packages
named in the allowlist in transformIgnorePatterns, so every suite that
reached a dialog died with "Must use import to load ES Module" from
domhandler. Add domhandler, domelementtype and htmlparser2 to the allowlist,
which is the smallest set that untangles the chain.

The allowlist approach fails closed and will keep catching us out on each
ESM-only bump; #10443 covers inverting it properly.
2026-09-21 12:58:44 +01:00
Dave Page 7c6fb89b82 Keep Make.bat stored with CRLF
.gitattributes normalises everything to LF, which rewrote the whole file
the first time this branch touched it and turned a two-line merge into a
whole-file conflict. Make.bat has been stored with CRLF since long before
that rule, so it is marked -text to leave it that way.
2026-09-21 12:51:22 +01:00
Dave Page a2439b78f5 Merge remote-tracking branch 'upstream/master' into worktree-qa-builds-on-actions
# Conflicts:
#	Make.bat
#	pkg/win32/README.md
2026-09-21 12:49:27 +01:00
Dave Page 14a796c427 Trigger the new build checks on master alone
The buildfarm-to-actions trigger existed so the branch could be tested
before it landed, which it no longer needs to be.

The four that filter on web/** also gain the message catalogue exclusion
that #10441 applied to the workflows already on master, for the same
reason: a .po change cannot break a package build, and check-translations
compiles the catalogues anyway.
2026-09-21 12:47:07 +01:00
Grégoire Bellon-Gervais 53729372a7 Include the authenticated user in the access log on logout (#10410)
Flask-Login has already cleared current_user by the time after_request
runs on a logout, so the X-Remote-User header, and with it the username
in the HTTP access log, was missing for exactly the requests that record
someone leaving. Stash the name on flask.g in before_request whilst it is
still available, and fall back to it when setting the header.

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
2026-09-21 12:31:06 +01:00
dependabot[bot] 08f643e619 Javascript dependency: bump electron from 43.4.0 to 44.4.2 in /runtime (#10359) 2026-09-21 12:29:04 +01:00
Marvin A. Ruder 2bb59c0b10 Prefer the user's email address as the Gravatar identifier (#10416)
The user menu avatar was always hashed from the local pgAdmin username,
so a user whose Gravatar profile is registered against their email
address (commonly the case when the account came from an OAuth2
provider) got a default avatar, or worse, the avatar belonging to
somebody else who happens to share that username. The email address is
now used where one is known, falling back to the username otherwise.

Fixes #10415
2026-09-21 12:24:16 +01:00
dependabot[bot] e1ad058990 Javascript dependency: bump qs from 6.15.2 to 6.16.0 in /web (#10375)
The lockfile is regenerated here; Dependabot bumped only the resolutions entry, which left the lockfile inconsistent and failed every install.
2026-09-21 12:22:58 +01:00
dependabot[bot] 4e23684096 Javascript dependency: bump @xmldom/xmldom from 0.8.13 to 0.8.15 in /web (#10377)
The lockfile is regenerated here; Dependabot bumped only the resolutions entry, which left the lockfile inconsistent and failed every install.
2026-09-21 12:22:58 +01:00
dependabot[bot] c5e67bdc67 Javascript dependency: bump bignumber.js from 10.0.2 to 11.1.5 in /web (#10337) 2026-09-21 12:22:58 +01:00
dependabot[bot] 07d2f4dbc5 Javascript dependency: bump postcss-selector-parser from 7.1.1 to 7.1.5 in /web (#10369) 2026-09-21 12:22:58 +01:00
dependabot[bot] ca4fe9d08a Javascript dependency: bump fast-uri from 3.1.5 to 3.1.6 in /web (#10374) 2026-09-21 12:22:58 +01:00
dependabot[bot] 2d2402c822 Javascript dependency: bump browserslist from 4.28.2 to 4.28.8 in /web (#10376) 2026-09-21 12:22:58 +01:00
dependabot[bot] 9195037213 Javascript dependency: bump @humanfs/node from 0.16.7 to 0.16.8 in /web (#10378) 2026-09-21 12:22:58 +01:00
dependabot[bot] 9e31eebe26 Javascript dependency: bump js-yaml from 3.15.1 to 3.15.2 in /web (#10405) 2026-09-21 12:22:58 +01:00
dependabot[bot] ebbe4e36d8 Javascript dependency: bump baseline-browser-mapping from 2.10.16 to 2.11.21 in /web (#10406) 2026-09-21 12:22:58 +01:00
dependabot[bot] aca8796178 Javascript dependency: bump devalue from 5.8.1 to 5.9.2 in /web (#10431) 2026-09-21 12:22:58 +01:00
dependabot[bot] 27809a95ef Javascript dependency: bump the runtime-javascript-minor-and-patch group across 1 directory with 3 updates (#10411)
Bumps axios from 1.19.0 to 1.20.0, eslint from 10.8.1 to 10.10.0 and globals from 17.11.0 to 17.12.0.
2026-09-21 12:22:58 +01:00
dependabot[bot] 211f9bf1f3 Javascript dependency: bump @humanfs/node from 0.16.7 to 0.16.8 in /runtime (#10379) 2026-09-21 12:22:58 +01:00
dependabot[bot] df39657d6d Javascript dependency: bump fast-uri from 3.1.5 to 3.1.6 in /runtime (#10373) 2026-09-21 12:22:58 +01:00
dependabot[bot] 79f5bdfb40 Python dependency: bump the regression-python-minor-and-patch group in /web/regression with 2 updates (#10433)
Bumps psycopg from 3.3.4 to 3.3.5 and selenium from 4.48.0 to 4.49.0.
2026-09-21 12:22:58 +01:00
rlbxku1r 5c7f0bdb05 Update Japanese translation for v9.18 (#10423)
Bring the ja catalogue up to full coverage against the current message
template, taking it from 3313 to 3684 translated strings, and refine
eleven existing translations. The compiled catalogue is included and
matches the source exactly.
2026-09-21 12:17:53 +01:00
ShiPing 5060cd8bc0 Update Chinese (Simplified) translation (#10439)
Refresh the zh_Hans_CN catalogue against the current message template,
taking it from 2681 to 3684 translated strings, so every message in
messages.pot is now covered. A further 1419 existing translations were
revised for consistency and accuracy, including a handful that were
plainly wrong ("Drop Table/Relation" rendered as "add table/relation").
2026-09-21 12:14:02 +01:00
Dave Page d7a6a89df3 Do not run the whole matrix for a translation update (#10441)
Message catalogues live under web/, so every workflow filtering on web/**
fires for a .po change: both feature test suites, all three database test
suites, the container build and the tarball and wheel builds. None of them
can be broken by a translation, and check-translations already runs
msg-compile, which is the check that would catch a malformed catalogue.

The two JavaScript workflows need no change, their filters being narrow
enough to miss .po files already.
2026-09-21 12:05:05 +01:00
Dave Page 7dc7292d53 fix(pkg): stage the Windows Kerberos runtime next to libpq (#10440)
PostgreSQL 18 and later are now built with GSSAPI support, so the
libpq.dll we ship has a load-time dependency on gssapi64.dll where it
previously had none. The installer staged the MIT Kerberos runtime into
the python directory only, which left two problems.

pg_dump.exe, pg_dumpall.exe, pg_restore.exe and psql.exe live in the
runtime directory next to libpq.dll, and could no longer load it, so
backup and restore failed with a complaint that gssapi64.dll could not
be found. Adding the python directory to PATH worked around it.

Connections crashed with "exception: access violation writing
0x0000000000000000" against any server that accepts GSSAPI encryption,
which is most Linux and cloud builds, whilst servers that decline it
carried on working. We never staged krbcc64.dll, and on Windows krb5
statically defaults krb5_cc_dfl_ops to the CCAPI credential cache and
only switches away from it if that DLL loads, so its entry points were
left null and the first use of the default credential cache called
address zero. libpq asks for a credential cache on every connection
under the default gssencmode of prefer, and because psycopg falls back
to its ctypes binding on Windows, CPython caught the access violation
and reported it in the Connect to Server dialog rather than taking the
process down.

Stage the Kerberos runtime into the runtime directory instead, once,
adding krbcc64.dll and the ccapiserver.exe it drives. That serves the
client binaries directly, and serves libpq loaded by psycopg too, since
the runtime directory is prepended to PATH before Python is spawned and
a DLL's own directory is searched for its dependencies. Nothing is left
behind on upgrade, because the installer already deletes the python
directory before it installs. Whilst here, correct the build
instructions, which still claimed that the PostgreSQL build has no
Kerberos support, and fix a stray "L%" on the end of the pg_dumpall.exe
copy, which stopped a failure there aborting the build.

Issue #10428
2026-09-21 11:18:12 +01:00
Dave Page 6f322ea160 Address the pre-merge review
Ten fixes from a review pass with fresh eyes. The ones that mattered:

rebuild-yum-repo.sh signed repomd.xml with no -u, so it used whatever
the keyring's default key resolved to. That is the packaging key today
only because there is one secret key in it. A repository whose metadata
is signed by the wrong key is one every client with gpgcheck=1 rejects,
produced by a run that exits 0.

The snapshot publish gate required only deb and rpm, whilst its comment
justified exactly one exception. A failed docs, tarball or wheel job
published a snapshot missing those files, and a failed repo-rpm job was
worse: install-repo-readme.py then fails after the packages are uploaded
and signed, leaving half a snapshot on the download server.

The location input was interpolated into shell on the runner holding both
publishing keys. It now travels through the environment, and is validated
against the shape of a datestamp before anything downstream sees it, so a
bad one fails in five seconds rather than after an hour of building.

Make.bat tested %ERRORLEVEL% inside a parenthesised block, where it is
expanded at parse time, so a failed Authenticode signature on
pgAdmin4.exe was undetectable; the handler was PAUSE, which on a headless
signing host either returns at once or blocks until the job times out.
Both sites now fail the build.

A called workflow inherits the caller's ref, so once this is on master an
ordinary push would have shared a concurrency group with the nightly
snapshot's builds and cancelled them.

And PULL_KEY named a file that does not exist on the download server,
which would have failed the first release promotion.

The rest: if-no-files-found on every build artefact, so a build that
produces nothing fails rather than silently shipping a snapshot without
it; pinned syft and helm installers, which were piping a default branch
into a shell as root in the container that builds signed packages; the
Helm chart no longer built and discarded; and the comments that had
stopped describing the code.

The self-test grows from 56 cases to 70, covering the verbs that delete
things, arguments that look like options, and the SSH_ORIGINAL_COMMAND
entry point rather than only the dry-run path.
2026-09-21 09:30:46 +01:00
Dave Page b8ac3485ad Give rpmsign the key identity rather than relying on a dotfile
rpmsign refuses to run without %_gpg_name, and the buildfarm satisfied
that with a ~/.rpmmacros on each build agent. Signing has moved to the
download server, which has never signed an RPM and has no such file, so
the first real snapshot-sign failed there.

Passing it explicitly suits this better than adding the dotfile: the key
is already a constant in this file, for the same reason the client cannot
name one, and the result no longer depends on whose home directory the
wrapper runs in.
2026-09-18 14:36:30 +01:00
Dave Page 1a2bbac26e Clear the staging directory before assembling into it
roadie's workspace persists between jobs, so yesterday's aborted run
left stage/2026-09-17-2 behind and today's run found two dated
directories where it expected one. The guard caught it and refused to
guess, which is the right outcome, but the tree should not have been
there to find.

The merged assemble job begins with a checkout, which cleans the
workspace as a side effect, and this does not depend on that.
2026-09-18 11:40:55 +01:00
Dave Page 67086aabff Filter the branch's own build checks too
The path filters that just landed on master cover the workflows that
exist there. These five are new on this branch and were still firing on
every push, which is what starved the macOS runners repeatedly today:
each documentation or workflow commit started two macOS appbundle builds
that no change could possibly have affected.

Each now lists what it builds from. The two that consume pgbuild also
list the composite action that fetches it, since a change to how the
dependencies are installed changes the build as surely as the packaging
does.
2026-09-18 11:35:18 +01:00
Dave Page d6262db305 Merge remote-tracking branch 'upstream/master' into worktree-qa-builds-on-actions 2026-09-18 11:34:31 +01:00
Dave Page d317a93019 Only run each CI workflow when something it tests has changed (#10427)
* Only run each CI workflow when something it tests has changed

Every workflow fired on every push and every pull request, so a commit
touching nothing but documentation or a workflow file started the whole
matrix: two macOS jobs, the EPAS and PostgreSQL feature tests, the
container build and the rest. That is slow for the contributor waiting
on a green tick and wasteful of the hosted runners, and macOS capacity
in particular is the one resource we can actually exhaust.

Each workflow now lists the paths it depends on, and its own file, so
editing it still runs it. The scope is deliberately per workflow rather
than shared: eslint and Jest care about the JavaScript and the files
that configure it, pycodestyle cares about Python anywhere in the tree,
the documentation build cares about docs plus the version and branding
it renders, and the packaging checks care about their own pkg
subdirectory alongside the application.

sonarqube-scan is left alone deliberately, being a whole-repository
quality scan rather than a test of any particular thing.

* Widen the path filters to inputs I had missed

All eight review findings check out against the tree, so all eight are
applied:

- The container build copies docs into the image, and .dockerignore
  decides what the build context contains at all.
- The documentation build imports web/config.py from conf.py.
- make install-python runs tools/setup-python-env.sh, so it belongs in
  every workflow that calls it, which is eight of them.
- pkg/pip/build.sh packages LICENSE and README.md and builds the docs;
  pkg/src/build.sh does much the same for the tarball.
- The Yarn and Babel configuration, web/.yarnrc.yml and
  web/babel.config.json, change what eslint and Jest do, and the
  JavaScript workflows filter on JavaScript rather than all of web/.
- tools/get_sb_package.py is fetched by the PostgreSQL and EPAS Python
  test workflows.

One deviation: get_sb_package.py goes to run-python-tests-pg and
run-python-tests-epas, which use it, rather than to server-mode, which
does not.
2026-09-18 11:33:50 +01:00
Dave Page 992ce03b43 Assemble on roadie, alongside the publishing
Splitting the two meant assembling a tree of several hundred megabytes
on a hosted runner, uploading it as an artifact, and immediately
downloading it again on roadie, which is where it was going anyway. The
hosted runner also has to be waited for: the second end-to-end run had
every build finished and then sat queued for assemble behind nine
unrelated master workflows.

Roadie is dedicated and nothing else queues for it, so the job now runs
there start to finish. Only the publishing steps are guarded by the
publish input, so a dispatch without it still proves the tree assembles,
which was the other reason for keeping them apart.

What goes is the assembled tree as a downloadable artifact. It was a
copy of something that ends up on the download server, where it can be
looked at directly.
2026-09-18 11:23:08 +01:00
Dave Page 14b3137ef1 Refuse a public key where a private one is needed
The pre-flight check tested only that the key file was readable, which a
.pub file also is, so a variable naming the wrong half of the pair passed
here and failed later inside ssh with a message that does not say which
file it objected to. Both halves live in one directory with names a
suffix apart, so it is an easy thing to get wrong and a cheap thing to
catch.
2026-09-18 09:18:44 +01:00
Dave Page 1f6076f888 Put every RPM in its distribution's tree, noarch included
The first end-to-end run assembled yum/redhat/rhel-9-noarch and three
more like it, because the architecture was taken from each package's own
filename. pgadmin4 and pgadmin4-web are noarch, so on a real publish the
metapackage and the web package would have been missing from every
repository: dnf asks for <name>-<version>-$basearch and never looks in a
noarch directory. The live snapshots have them in rhel-9-x86_64
alongside the rest, which is what this now produces.

x86_64 is a constant here because that is the whole RPM matrix today; it
becomes a property of the build when aarch64 arrives.

Found by diffing the assembled tree against a snapshot the buildfarm
produced, rather than by the build failing, which it would not have.
2026-09-17 16:58:09 +01:00
Dave Page 2a4492ea5d Bring the platform build READMEs up to date
The Windows one still pointed at dpage/winpgbuild and told people to dig
a binaries asset out of a workflow run. pgbuild publishes proper releases
now, each tagged *-latest, so both platforms get a predictable URL and
the same binaries CI uses. syft is added to the Chocolatey list, the
build having needed it since the SBOM step went in.

The macOS one claimed Python 3.6+, which has not been true for a while
and is now doubly confusing given the build downloads the interpreter it
bundles: the two are separated, and the version that ships is pointed at
pkg/python-version.txt. It also never mentioned syft or wget, both of
which the build needs, or that Homebrew's PostgreSQL lacks the zstd and
lz4 support ours is built with.
2026-09-17 15:14:09 +01:00
Dave Page f703f10d83 Give each workflow its own concurrency group
github.workflow in a reusable workflow is the CALLER's name, so every
build Snapshot calls landed in one group, 'Snapshot @ <ref>', with
cancel-in-progress set. Each called build therefore cancelled the one
before it: the first dispatched run finished with deb, rpm, docs,
tarball, wheel and helm all cancelled, and only the two jobs defined
inline in the orchestrator surviving.

Each workflow now names its own group literally.

Also restores snapshot-macos.yml, which the previous commit truncated to
its trigger block: the expression used to strip the push trigger matched
across the rest of the file and took the concurrency settings, the
permissions and the entire appbundle job with it.
2026-09-17 15:07:32 +01:00
Dave Page f7cd7f4d63 Run snapshots nightly rather than on push
A push trigger was never the intent; it was there because a workflow off
the default branch has no dispatch button, and it is what caused the
orchestrator to run alongside the standalone signing workflows it calls.

Nightly at 01:01, which is when pgadmin4-all-snapshot ran, plus
workflow_dispatch for testing and reruns.
2026-09-17 15:06:05 +01:00
Dave Page 6f7685a111 Stop the signing workflows firing on push as well
They each had a push trigger, added when they were standalone and there
was no dispatch button for a workflow off the default branch. Now that
the orchestrator calls them, a push touching pkg/mac or pkg/win32 starts
them twice: once directly and once through Snapshot. The first push
after they became callable did exactly that, and the resulting contention
for the macOS runners and the one Windows signing host left the real
dispatched run queued behind its own duplicate.

They keep workflow_dispatch, so either can still be run alone.
2026-09-17 14:58:21 +01:00
Dave Page 2d8479feab Build the repository configuration RPMs for the snapshot
Every snapshot on the download server carries
pgadmin4-fedora-repo-2-1.noarch.rpm and its redhat counterpart at the
root of yum/, and the README tells people to install one before anything
else. Nothing in the new flow produced them, so install-repo-readme.py
could not name them and snapshot-index-yum would have failed.

They are not a build of pgAdmin, which is why no QA workflow makes them:
each is a single .repo file pointing at the tree it ships in. That is
also why the destination has to be known before they are built, and why
the directory name is now decided once by its own job rather than by
each job calling date. Two jobs calling date independently would, on a
run straddling midnight, have shipped a repository configuration
pointing at a snapshot that does not exist.

They are left unsigned here and signed on the server with everything
else, since they land under yum/ where snapshot-sign finds them.
2026-09-17 14:50:34 +01:00
Dave Page e46d9cb08e Match the layout the servers actually use
Verifying against paxsor and procyon before the first run turned up that
the flow had the wrong shape, which would have produced a snapshot
nobody could install from.

A staging build and a snapshot are flat: apt/, yum/, and the
downloadable files loose beside them. It is only a published release
that is divided into docs/, macos/, pip/, source/ and windows/, and the
promotion job sorts files into those on the way to v<VERSION>. We had
the release layout applied to all three, so stage-create and
snapshot-create made directories nothing uses, the assembled tree put
every file one level too deep, and sign_packages looked for things to
sign in directories that would have been empty. A snapshot would have
gone out unsigned.

Signing is now driven by extension and location rather than by a list of
directories, so it is right for both layouts: RPMs under yum/ signed in
place, and detached signatures for the tarball, wheel, documentation
tarball, PDF and ePub wherever they sit. Debs are left alone, apt
verifying them through the signed Release file, as are the disk images,
ZIPs and installer, which carry signatures of their own.

The documentation also gets versioned filenames, the build leaving them
as pgadmin4.pdf and pgAdmin4.epub whilst the download site has always
carried pgadmin4-<version>.pdf and .epub.
2026-09-17 14:45:37 +01:00
Dave Page df76b1ba34 Build the RPMs against PostgreSQL 18
pkg/redhat/build.sh bundles postgresqlNN-libs into the yum trees,
choosing NN from the highest /usr/pgsql-1* on the build host rather than
from a constant, so the version that ships is decided by what the build
environment installs. Ours installed postgresql17-devel, so the
repositories carried postgresql17-libs alongside a libpq5 from 18.

pkg/redhat/setup.sh was staler again at postgresql15-devel, in all three
of its distribution branches.
2026-09-17 14:45:37 +01:00
Dave Page 6920a58d91 Do not enforce snapshot retention on a test run
snapshot-purge ran at the end of every publish, so the first test run
would have deleted the older snapshots the buildfarm put on the download
server, which is exactly what we agreed a test must not touch. A run
that names its own directory is a test by definition, so that is the
signal to leave retention alone.

Also fails rather than guessing when the artefact does not contain
exactly one dated directory, and checks for ssh and rsync up front.
2026-09-17 14:16:56 +01:00
Dave Page 1545bcc91c Send snapshots to the download server, not to staging
I had the two flows conflated. Release candidates are staged on the
development server and promoted; snapshots are published straight to the
download server under snapshots/<date>, which is what every
*-snapshot job in the buildfarm targets.

So the publish job talks to the download server, the wrapper grows the
snapshot verbs it needed and loses snapshot-fetch, which existed only to
copy a staging build that is never made, and the variable is named for
the server it actually names.

It also reverses my advice about the upload key on the download server,
which I had said to drop on the reasoning that publication always pulls
from procyon. It does not, for snapshots. The key comes back, confined
to the snapshots tree, which is the right root on two counts: it is
where snapshots belong, and it is the one part of the download site that
the S3 sync excludes, so nothing written through it can reach the
archive or the mirrors.

snapshot-purge replaces the buildfarm's ls | tail | xargs rm. It is the
only verb that deletes anything, so it takes no argument: it cannot be
asked to remove a particular snapshot, only to enforce the retention the
server already has, and it ignores directories that do not look like a
snapshot.
2026-09-17 13:25:06 +01:00
Dave Page e4eb334599 Reference the publishing keys by path rather than copying them
They are already on roadie. Putting copies in the secret store would
mean two places to rotate them and two places to leak them from, so the
workflow names the paths and never handles key material.

What changes with it is where the boundary sits. An environment secret
is gated by a deployment branch policy; a file on disk is gated by which
workflows may run on that machine. This repository is public, so roadie
needs to be in a runner group restricted to these workflows, with
nothing triggered by pull_request targeting it. That is the same bargain
the Windows signing host already makes with the Certum token, but it is
now load-bearing in a second place, so it is written down.

The environment stays for the branch policy and the deployment record.
2026-09-17 13:19:13 +01:00
Dave Page 9f7dff40f1 Publish the assembled snapshot to the staging server
The last missing link: assemble produced a tree and nothing carried it
anywhere. The publish job uploads it over the rrsync-confined key and
then asks pga-publish to sign and index it, so the runner names a verb
and a datestamp rather than a command, and the signing happens where the
key is.

The staging directory can be named explicitly, because the buildfarm
writes <date> on that same server and a test run has no business landing
on the directory Jenkins is still filling. Publication is off by default
for the same reason: it takes an explicit input, so a dispatch that only
wants to know whether everything builds cannot reach the servers at all.

Also adds the deployment notes, which is where the four files go on each
host, what the two configuration files hold, and why no key gets a
shell.
2026-09-17 13:13:04 +01:00
Dave Page 596396acaf Move the publishing wrapper into pkg/publish and correct it
It was drafted from the Jenkins job definitions before anybody had
looked at the servers, and most of what it assumed about them was wrong.

The apt layout is per distribution release, with the packages sitting
directly in binary-<arch> and no shared pool, so packages-fetch and
stage-create were writing to paths that do not exist. The allowlists
were stale in both directions: plucky and RHEL 8 are not built, whilst
resolute, Fedora 43 and 44 were missing. sync-ftp-to-s3.py takes the
CloudFront distribution to invalidate rather than a choice of what to
sync, so that verb loses its argument entirely and reads the identifier
from the server, since the client has nothing to choose.

The indexing is no longer implemented here. It calls the scripts in this
directory instead, which are the same ones an administrator runs by hand
after purging old releases, so there is one implementation rather than
the four the buildfarm had. That also settles the doubled signing the
draft worried about: the scripts sign as part of indexing.

New verb: stage-sign. With the GPG key staying on the servers rather
than moving into Actions secrets, the workflow uploads unsigned
artefacts and asks for them to be signed here. A compromised workflow
can therefore ask for a signature over something it just uploaded, which
is real and acknowledged; what it cannot do is hold the key, sign out of
band, or sign with any other key.

The self-test covers 56 cases and passes.
2026-09-17 13:10:13 +01:00
Dave Page 3c038f8fd5 Add the snapshot orchestrator, calling the build workflows
Replaces pgadmin4-all-snapshot and the dozen per-artefact snapshot jobs
it drove. Those were separate job definitions carrying the same commands
as their QA counterparts, which is how a snapshot comes to differ from
what QA tested; here the build workflows gain a workflow_call trigger
and the orchestrator calls them, so there is one definition of each
build.

Nothing in it signs anything beyond the macOS notarisation and the
Windows signature, which have to happen where their credentials are. The
GPG key that signs RPMs and repository metadata stays on the servers, so
the workflow assembles the tree and uploads it, and procyon indexes and
signs it. A compromised run can ask for a signature; it cannot make one.

The assembled layout is the one the publishing scripts and the download
site expect. Debian architectures come from the package filenames, since
dpkg encodes them there; the codename does not follow from the build
name, so that mapping is explicit and fails loudly on an unknown one.

The Helm chart is built but not assembled: it goes to an OCI registry
rather than the download tree.
2026-09-17 12:49:54 +01:00
Dave Page f149cf4b81 Derive the repository README platform tables
The support matrix was maintained by hand in five Jenkins heredocs,
which is exactly why the published one had drifted: it stops at Noble
and still lists Mantic, whilst the job that writes it goes up to
Resolute.

It is now derived, and the two sources are deliberately different. Which
platforms are supported comes from the repositories present in the tree
being written, since that is what a user can actually install from.
Which releases each platform carried comes from the S3 archive rather
than the download server, because old releases are purged from the
server as they age: bookworm reads as 7.8 there against 7.0 in the
archive, so deriving history from the server would quietly rewrite it
every time somebody tidied up. The sync has no --delete, so the bucket
keeps everything.

Platforms that are no longer supported get their own table with the last
release each carried, which turns the standing note about the archive
into something a user on an old distribution can act on. For snapshot
and pre-release trees --no-archive drops that section and the release
columns with it, since every package there is from the one build.

Cross-checked against the hand-written tables: every value they assert
is reproduced, including bookworm 7.0, jammy 6.9, bullseye 4.30 to 9.14
and fedora-42 9.3 to 9.17. Two they got wrong come out right, RHEL 10
having been copied from the RHEL 9 row as 6.12 when it is 9.6.

Two traps worth naming. aws s3 sync follows symlinks, so the EL
compatibility links exist in the bucket as full copies and would
otherwise invent platforms like fedora-31Client. And Debian versions
carry a packaging revision now, as in 9.16-1.resolute, which sorts below
9.3 unless it is stripped first.
2026-09-17 12:41:22 +01:00
Dave Page 7ea9a6bb35 Bring aptftp.conf across from the download server
It lived unversioned in pgaupload's home directory on paxsor, which also
made it writable by the account the publishing scripts run as, despite
being an input to what gets indexed and therefore to what gets signed.

Taking it here settles both: changing the repository's Origin, Label or
architectures becomes a reviewed commit, and the copy on the server can
become root owned.

The default architecture list drops i386 to match. apt-ftparchive has
been writing dists/pgadmin4/main/binary-i386/Packages for years, but
Architectures in the Release file has only ever said 'amd64 all', so no
client has been able to reach that index through the signed metadata.
Nothing that works today stops working.
2026-09-17 12:21:38 +01:00
Dave Page 2db86f9d0a Drop the bash step from the pgbuild dependency action
The action ran a final step whose only job was to publish whichever of
the two platform steps' outputs had been set, and it did that in bash.
The hosted Windows image has bash by way of Git for Windows; the signing
host does not, so the Windows snapshot build failed with 'bash: command
not found' before it reached anything interesting.

An expression does the same job without needing a shell to exist.
2026-09-17 12:14:14 +01:00
Dave Page 5a694d2f48 Add pkg/publish: one implementation of the repository indexing
The sequence that indexes and signs an APT repository existed in four
places that differed only in which directory they ran against: inline in
the pgadmin4-deb-build, pgadmin4-deb-snapshot and
pgadmin4-deb-publish-qa-to-prod Jenkins jobs, and in rebuild-apt-repo.sh
in the pgaweb repository. The YUM equivalent existed in five, and the
repository READMEs were heredocs in five more jobs.

These are those sequences, once each, with the tree root as an argument
so that the staging, snapshot and production trees share one
implementation, and with the architecture parameterised rather than
x86_64 spliced into the paths, since we will want to publish for arm64
before long. The APT script passes the architecture list to
apt-ftparchive as an override rather than letting it come from
aptftp.conf, so the set indexed and the set advertised in the signed
Release file cannot drift apart; a package whose architecture is missing
from Release is ignored by every client, silently.

Run with no options they behave exactly as the pgaweb copies did, so
rebuilding a repository by hand after purging old releases is unchanged.

aptftp.conf still needs to be brought across from the download server.
2026-09-17 12:13:32 +01:00
Dave Page 432d74bf1b Decide the Python version in one file rather than three places
Which Python pgAdmin builds against and ships has until now been settled in
three unrelated places. On Windows, Make.bat used whatever %PGADMIN_PYTHON_DIR%
pointed at, which the buildfarm's Jenkins node configuration injected, and then
derived the embeddable distribution it actually ships from that interpreter's
own sys.version. On macOS, pkg/mac/build.sh defaulted to a version of its own
whilst the workflows overrode it with a third, copied from the buildfarm's
DEFAULT_PYTHON_VERSION. Locally it was whatever the developer happened to have.
A single commit could therefore ship different interpreters on different
platforms with nothing anywhere announcing it, which nearly happened: a workflow
that discovered Python from the PATH would have shipped 3.14 on Windows against
3.13 on macOS.

The version now lives in pkg/python-version.txt, which every platform's
packaging reads. It is a file in the tree rather than a GitHub variable because
a local build has to read it too, and because a change of interpreter should
arrive as a commit somebody can review rather than as a settings change made on
an agent. The format is KEY=value with # comments, dull on purpose: it has to be
parsed by a batch file, by a shell script and occasionally by a person, and
anything richer would need a parser in at least one of those. It carries both
the exact CPython version and the python-build-standalone release tag, since
that project's releases are dated rather than versioned and the archive names
embed both.

Make.bat no longer depends on an installed Python at all. It downloads the
relocatable distribution named in that file, unpacks it into the build tree and
installs virtualenv into it, then fetches the matching embeddable distribution
from python.org for what actually ships, so the two can no longer disagree.
python-build-standalone suits the signing host particularly well, being a plain
tarball rather than an installer and so raising no UAC prompt, which matters
because an elevation dialog in that machine's auto-logged-in session waits
forever for somebody who is not there. curl.exe and tar.exe have shipped in
Windows since 1803, so nothing needs installing to bootstrap it. Both Windows
workflows consequently lose their Python setup, and the signing host needs
neither a Python, nor a virtualenv installed into it, nor the
PGADMIN_PYTHON_DIR repository variable.

macOS only reads the version. It still builds its framework with
relocatable-python, because python-build-standalone's relocatable distributions
are not framework-shaped and replacing what is shipped there would mean
reworking the codesigning and the @loader_path rewriting in _fixup_imports,
which is a job of its own.

The version itself is unchanged: 3.13.15 is what the released installers
already carry, and this makes that existing choice explicit rather than a
different one.
2026-09-17 10:16:50 +01:00
Dave Page 892681f78d Queue rather than cancel concurrent macOS signing builds
Copied from the QA builds without thinking, where cancelling an in-flight run
on a new push is exactly right: the tip is what matters and a superseded build
is wasted effort.

A signing build is not that. Cancelling one throws away forty minutes of work,
and worse, it can abandon a notarisation already submitted to Apple, leaving a
request in their queue for a build nobody will ever collect. The Windows
snapshot already queues rather than cancels, for the related reason that there
is one hardware token, so this brings the two into line.

Found by cancelling my own in-flight Intel notarisation with an unrelated push.
2026-09-16 15:48:23 +01:00
Dave Page ad5b6ae2c7 Extract the pgbuild dependency install into a composite action
Four workflows fetch these — the QA and snapshot builds on each of macOS and
Windows — and the duplication has already cost something: the first version
used the gh CLI, which turned out not to exist on the self-hosted Windows
runner, and the same fix had to be made in two places. There will be more of
them as the snapshot and release builds fill in.

The action carries the parts that are easy to get wrong and tedious to
rediscover. On macOS the archives must land in /opt/pgbuild precisely, because
the install names inside are absolute and _fixup_imports copies from those
paths whilst rewriting the references. On Windows the location only has to
avoid the C:\build64 that the buildfarm's Jenkins worker deletes and
re-extracts, hence the runner's temp directory. Downloads are plain HTTPS
rather than a CLI, since pgbuild is public and its URLs are predictable, and
both curl --fail and Invoke-WebRequest fail on a 404 rather than writing an
error page to disk and failing later at the unpack.

Deliberately not reusable workflows, which was the first idea. The signed
builds need environment: signing and the QA builds must not have it, and there
is no clean way to express "no environment" as an input, so factoring at that
level would have meant either handing the QA builds access to the signing
certificate or contorting around it. The duplication that actually hurt was the
steps rather than the workflows.
2026-09-16 15:47:46 +01:00
Dave Page 5326c1524f Take the signing credentials from a "signing" environment
"snapshot" was the wrong name for the boundary. The same Developer ID and
notarisation credentials serve both the snapshot and the release builds, so
naming the environment after one occasion would have meant either duplicating
the secrets or referring to "snapshot" from a release workflow. Naming it for
what it holds rather than when it runs avoids both.

Worth knowing that the old environment was never created deliberately: GitHub
creates one the first time a workflow references it, so an environment
appearing in the settings is not evidence that anyone intended it.
2026-09-16 14:57:50 +01:00
Dave Page 96b72d76f1 Fetch the Windows build dependencies without the gh CLI
The signed build failed with CommandNotFoundException on gh. Hosted runners
ship the GitHub CLI; a plain Windows machine does not, and the signing host is
the one machine in the pipeline that cannot be rebuilt, so the fewer things it
must have installed the better.

pgbuild is public and its asset URLs are predictable, so this needs neither a
CLI nor authentication. Invoke-WebRequest throws on a 404, so a missing release
still fails immediately rather than writing an error page to disk and failing
later at Expand-Archive, which was the reason for preferring gh in the first
place.

The hosted QA build changes the same way, though it has gh and did not need to.
One mechanism for the same job is worth more than the small convenience,
particularly if that build ever moves to a self-hosted runner.

ProgressPreference is silenced because Invoke-WebRequest otherwise spends most
of a 90 MB download rendering a progress bar into a log nobody will read.
2026-09-16 13:58:09 +01:00
Dave Page d37e8fe798 State which Python the Windows build uses rather than discovering it
The previous attempt took whatever python was on PATH, which was wrong in a way
that would not have announced itself. The signing host has 3.14 on PATH, whilst
the buildfarm's Jenkins job injects PGADMIN_PYTHON_DIR pointing at 3.13, so the
two systems would have built the same commit against different interpreters and
shipped different runtimes, with nothing failing to indicate it.

Which Python we ship is a decision. It now comes from a repository variable,
set to match Jenkins, so it is stated once rather than inherited from whichever
Python was installed on a machine most recently. The build fails if the
variable is unset rather than falling back to something plausible, because a
plausible fallback is exactly how this went unnoticed in the first place.

This is the interim arrangement. The version belongs in a file in this
repository, with each platform fetching a private Python of that version at
build time, so that local builds cannot drift either and the Windows host needs
no system Python at all. That wants doing before the system Python goes rather
than after, and deserves its own change rather than being done in the middle of
getting signing working.
2026-09-16 13:52:30 +01:00
Dave Page b60ac47346 Use Windows PowerShell rather than pwsh on the signing host
The second run failed immediately with "pwsh: command not found". PowerShell 7
is not on that machine: GitHub's hosted Windows images ship it, a self-hosted
Windows box has only Windows PowerShell 5.1 unless somebody installed it, and
nothing should be installing it on this machine to suit a CI job.

Nothing here needs PowerShell 7, so the steps use the shell that is present.
One thing does change with it, and it is the sort of difference that produces a
baffling failure rather than an obvious one: Out-File in 5.1 defaults to
UTF-16, so writing to GITHUB_ENV without an explicit encoding produces a file
the runner cannot parse and every variable set that way silently goes missing.
Hence -Encoding utf8 on each, which is what GitHub's own documentation
prescribes for this shell.

The hosted Windows QA build keeps using pwsh, since hosted images have it and
it is the better shell where there is a choice.
2026-09-16 12:59:27 +01:00
Dave Page 5dcf165a0a Use the signing host's own Python rather than actions/setup-python
The first run on the self-hosted runner hung on setup-python for thirty
minutes, against eleven seconds for setup-node, and had to be cancelled. On
Windows that action installs Python rather than unpacking it, and anything
raising a UAC prompt in the auto-logged-in session waits forever with nobody to
answer it. Which is the PIN dialog problem wearing different clothes, and worth
remembering as a property of this machine: anything that might prompt will hang
rather than fail.

The machine has a Python already, which is what the buildfarm's Jenkins job
uses, so the workflow finds it on PATH and derives PGADMIN_PYTHON_DIR from
that. It is also closer to what we are actually testing here, since the point
of building on this box rather than a hosted runner is to exercise its
environment.

virtualenv is checked rather than installed, consistent with the other
prerequisites: a CI job should not be modifying the one machine in the pipeline
that cannot be rebuilt, so it stops with the command to run instead.
2026-09-16 12:57:57 +01:00
Dave Page b6ed164952 Document the Windows signing host in pkg/win32
The signing host is about to become the only machine in the release pipeline
that cannot be rebuilt from something. Everything else either disappears or
becomes an ephemeral runner described entirely by a workflow file; this one is
configured by hand and holds a certificate on a hardware card that cannot be
copied or exported.

What documentation existed lived in the buildfarm repository, which is being
retired, and was written for the Jenkins arrangement. It also opened by saying
it was "preserved for reference only" because the configuration was "now
managed by Ansible roles", which was never true of this machine.

So this consolidates both notes into one document next to the build they serve,
rewritten for the GitHub Actions arrangement: the runner in an interactive
session rather than as a service, the Startup folder shortcut, the PIN helper,
the prerequisites the workflow checks for, and the PGADMIN_WINDOWS_CSC
repository variable.

The Certum material is preserved largely as it was, because it is hard-won and
none of it changes: CSP mode rather than Minidriver, importing to the machine
store, and above all the certificate-to-key repair via keyprov.inf, which the
card's own registration does not do correctly and without which signing either
fails or quietly degrades to SHA1. The troubleshooting section is kept for the
same reason, particularly that NTE_KEYSET_NOT_DEF almost always means someone
is on Remote Desktop.

Everything specific to an individual, a machine or a certificate stays out:
subject names, thumbprints, container IDs and passwords are placeholders, as
they were in the originals.
2026-09-16 12:25:27 +01:00
Dave Page 68536e70ec Add the signed Windows snapshot build
Replaces the buildfarm's pgadmin4-windows-x64-snapshot job, and it is the one
workflow that cannot use a hosted runner: the certificate is on a Certum
hardware token, reached through the machine certificate store, with a PIN
handler answering the prompt from the interactive desktop session. None of that
can move to a runner GitHub provides.

Setting PGADMIN_WINDOWS_CSC is the whole of what makes Make.bat sign, so the
build fails immediately if the variable is absent rather than quietly producing
an unsigned installer that looks like a successful snapshot. It is a repository
variable rather than a value in the tree: it is a person's name, and a
certificate renewal should be a settings change rather than a commit.

Three things differ from the QA build beyond the signing.

Nothing is installed. The hosted build runs choco; this machine is provisioned
by the buildfarm's Ansible and a CI job has no business mutating it, so the
prerequisites are checked and the build stops with a useful message if one is
missing.

Visual Studio, the VC++ redistributable and signtool are discovered rather than
hardcoded. The buildfarm pins all three in its Jenkins node configuration,
which then needs editing every time Visual Studio or the Windows SDK updates,
and signtool in particular lives at a versioned path.

Concurrency is a fixed group with cancel-in-progress off. There is one hardware
token, Jenkins may also be using it, and two builds signing through it at once
is a good way to discover what proCertum does under contention.

The verification step checks the executable inside the installer as well as the
installer itself. Make.bat verifies only the latter, and the former is the
thing users actually run.
2026-09-16 12:20:46 +01:00
Dave Page 65557f1814 Trigger the new workflows on the working branch
These all trigger on pushes to master, which means that on a working branch
they never run and the branch cannot be tested at all. So the branch is named
alongside master in the triggers, to be removed when it merges.

The snapshot build needs different treatment. workflow_dispatch only offers a
"Run workflow" button for workflows that are on the default branch, so whilst
it lives on a branch there is no way to trigger it by hand at all. A plain push
trigger would mean signing and notarising on every commit, which is both
wasteful and rude to Apple's notary service, so it fires only on changes to
itself or to pkg/mac, which is to say only when the thing under test changes.
2026-09-16 12:04:32 +01:00
Dave Page c436287365 Remove the DMG diagnostic spike
Its own header said to delete it once the cause was understood, and it is: the
unmount cost scales with the bundle, hdiutil's 120 second DiskArbitration
timeout cannot be raised, and detach -force waits on DiskArbitration exactly as
the polite detach does. The build now creates the image with hdiutil create
-srcfolder and never mounts a volume at all.

What the spike established is recorded where it will actually be read, in the
comments on _create_dmg and in the commit that replaced create-dmg, rather than
in a workflow nobody will run again: create-dmg's flags, the volume size, the
file count, Gatekeeper, Spotlight and the choice of runner image were each
tested and each exonerated.
2026-09-16 12:03:47 +01:00
Dave Page 473fe47895 Pass --deep when signing ad-hoc
The first ad-hoc run failed on the very first binary:

    Contents/MacOS/pgAdmin 4: replacing existing signature
    Contents/MacOS/pgAdmin 4: code object is not signed at all
    In subcomponent: Contents/LICENSE

The Developer ID path passes --deep on every codesign call and the ad-hoc one
did not. These are bundles with nested code, and without --deep codesign will
not replace the signature on one whose nested code is unsigned. Matching the
existing path is both the fix and the smaller surprise for anyone reading the
two branches side by side.
2026-09-16 12:03:20 +01:00
Dave Page c76fd6b3ee Add the signed, notarised macOS snapshot build
Replaces the buildfarm's pgadmin4-appbundle-snapshot job. Where the QA build
proves the bundle assembles, this produces something distributable: signed with
the Developer ID, notarised by Apple, stapled, and with a ZIP alongside the DMG
because the Electron auto-updater consumes the ZIP whilst the DMG is the
download people click.

The buildfarm keeps the Developer ID in the worker's login keychain and unlocks
it with devkeys/unlock-csc.sh. A hosted runner has no such keychain, so one is
created for the job and destroyed with it, under a generated password that
never outlives the run. set-key-partition-list matters more than it looks:
without it codesign asks permission to use the key, and on a headless runner
asking means hanging until the job times out.

The credentials sit on a "snapshot" environment rather than loose on the
repository, so only workflows that ought to be signing can reach them, and the
cleanup step runs even on failure, since neither a keychain holding a Developer
ID key nor a conf file holding an app-specific password should survive a failed
build.

Nothing is uploaded yet. This proves the signed build works; publishing is the
next piece. It is also workflow_dispatch only rather than nightly, so it cannot
start signing things before we intend it to.

Requires six secrets on the snapshot environment: MACOS_CERTIFICATE (the
Developer ID .p12, base64 encoded), MACOS_CERTIFICATE_PASSWORD,
MACOS_DEVELOPER_ID, APPLE_ID, APPLE_APP_SPECIFIC_PASSWORD and APPLE_TEAM_ID.
2026-09-16 12:03:20 +01:00
Dave Page 01cd0454a3 Unpack the Windows build dependencies under the runner's temp directory
C:\build64 was the obvious place to put them and the wrong one. It is what the
buildfarm's winpgbuild-update job manages on the Windows worker, where it
deletes and re-extracts postgresql and krb5 inside that directory.

That does not matter whilst these builds only run on hosted runners, which are
ephemeral and have no Jenkins on them. It matters a great deal as soon as the
signing builds run on that same machine as a self-hosted runner, because the
two systems would then take turns overwriting each other's dependencies, and
the Jenkins-side failures would look nothing like their cause: a build that
worked yesterday, with a PostgreSQL that is subtly not the one it was given.

So the path is derived from RUNNER_TEMP and passed on through GITHUB_ENV rather
than being a fixed constant. Nothing else changes, and QA stays on the hosted
runner.
2026-09-16 12:03:20 +01:00
Dave Page 778e00fc3b Sign the macOS bundle ad-hoc when there is no Developer ID
Without codesign.conf the build skipped signing entirely, which leaves a bundle
that cannot be run rather than merely one that cannot be distributed.

_fixup_imports rewrites install names across several hundred binaries, which
invalidates whatever signatures they arrived with, Electron's included. On
Apple Silicon the kernel refuses to execute a binary whose signature is broken
or absent, so an unsigned bundle will not launch at all there, even once the
quarantine attribute has been removed. On Intel it is less severe but no more
correct: every binary ends up carrying a signature that no longer matches its
contents.

So with no Developer ID we now sign ad-hoc. This is not a substitute for a real
signature and is not meant to be: the result is still refused by Gatekeeper and
still cannot be notarised, and the build says so. It just means an unsigned
build is something a developer can actually open after allowing it, which is
the entire point of producing one.

The signing arguments move into a helper so the two paths cannot drift, and the
dylib loop stops using find -exec so it can share them. Signing the disk image
ad-hoc would achieve nothing, since a signature there is about distribution, so
that one still does nothing without a Developer ID.

Worth noting this path had never run anywhere before: the buildfarm's macOS QA
job signs properly, because it runs on a machine with the certificate, so the
unsigned branch existed only in principle. The same was true of the Windows
installer's unsigned path until last week.
2026-09-16 12:03:20 +01:00
Dave Page 6a287fdb87 Stop installing the Python dependencies twice in the macOS build
_create_python_env installs the whole of requirements.txt into the framework
that gets shipped, and then _build_docs created a fresh venv and installed all
hundred-odd packages again. Both installs show up in every build log as
identical "Successfully installed Authlib-1.8.0 Babel-2.18.0 ..." lines a few
hundred lines apart.

The second install was not gratuitous: the doc build imports pgAdmin itself,
since docs/en_US/build_code_snippet.py pulls in config, pgadmin.utils,
pgadmin.browser.utils and the driver abstractions, so the dependencies have to
be importable. But they already are, in the framework populated moments
earlier, so the venv can inherit them instead. Sphinx still goes into the venv
rather than the framework, which is the reason the venv exists at all: it must
not end up in the shipped bundle.

--system-site-packages is safe here in a way it is not in the Linux build,
which deliberately avoids it. There the parent is a shared system Python that
may carry other packages' stale .pth files, and one of those corrupted sys.path
badly enough to break pip's own bootstrap on the el-10 builder. Here the parent
is a framework we built ourselves in this run, containing only our
dependencies. The comment says so, to save someone importing the Linux
workaround into a situation that does not call for it.

Windows already avoided the duplication by adding sphinx to the same
environment, though without the separation that keeps it out of the shipped
files.
2026-09-16 12:03:20 +01:00
Dave Page 5b1d7ec954 Build the Windows QA installer against pgbuild's dependencies
pgadmin-org/pgbuild supersedes dpage/winpgbuild, and now that a full
build-all-windows run has published the Windows artefacts, this points at them
instead. Both platforms then build against a single manifest of pinned
versions, which is the main reason for merging the two repos in the first
place: until now the macOS and Windows dependency versions were kept in step by
hand, in two places, with nothing enforcing it.

Verified against what Make.bat actually needs before switching. The krb5
archive unpacks to krb5/ and carries kinit.exe, krb5_64.dll, comerr64.dll,
k5sprt64.dll and gssapi64.dll; the PostgreSQL one unpacks to postgresql/ and
carries libpq.dll, zlib1.dll, the client binaries, libcrypto-3-x64.dll and
libssl-3-x64.dll, along with the optional liblz4.dll, libzstd.dll, libintl-8.dll
and libiconv-2.dll. So the directory layout the workflow already assumed is
unchanged and every file the build copies is present.

Downloads now go through gh rather than Invoke-WebRequest, which keeps the tag
and the asset name in one place and fails loudly if a release is missing rather
than writing an error page to disk and failing later at Expand-Archive.
2026-09-16 12:03:20 +01:00
Dave Page 346e4deff4 Build the macOS QA appbundle against pgbuild's dependencies
Homebrew's PostgreSQL was only ever a stand-in for the build check, and a poor
one: it has no zstd or lz4 support, which is issue #9425, it links Homebrew's
OpenSSL rather than the one we ship, and it carries whatever minimum macOS
Homebrew happened to build for. So the QA build proved that the bundle
assembles, but not that the binaries in it are the ones we intend to ship.

The dependencies now come from pgadmin-org/pgbuild, which builds OpenSSL,
Kerberos, zstd, lz4 and PostgreSQL against each other with a 14.0 deployment
target, matching the support policy. That makes the QA build the same thing the
release build will produce, minus the signing, and it exercises those artefacts
continuously rather than discovering a problem with them at release time.

They are unpacked into /opt/pgbuild specifically, because the install names are
absolute: pg_dump asks for /opt/pgbuild/zstd/lib/libzstd.1.dylib and libpq for
/opt/pgbuild/krb5/lib/libgssapi_krb5.2.2.dylib, among others. _fixup_imports
copies from those paths into the bundle and rewrites the references, so they
have to resolve during the build.

Which is also why /opt/pgbuild joins the prefixes _verify_bundle_linkage
rejects. An unrewritten reference to it is precisely the defect that check
exists to catch, no different from a dangling Homebrew path, and it would
otherwise pass unnoticed: the shipped binary would look fine on the build
machine and fail on a user's.

OPENSSL_DIR now points at our OpenSSL too, so the Intel cryptography build,
which compiles from source because there is no x86_64 wheel, statically links
the same OpenSSL as everything else in the bundle.
2026-09-16 12:03:20 +01:00
Dave Page c049488a11 Build the macOS disk image without mounting it, and drop create-dmg
The DMG was built by mounting a read/write volume, populating it, unmounting it
and converting the result. The unmount is the step that does not survive
contact with a slow machine: hdiutil waits on DiskArbitration with a fixed 120
second timeout that nothing exposes a way to raise, and the cost scales with the
bundle. Measured on GitHub's hosted runners with an identical payload it takes
around 20 seconds on arm64, 41 on macos-26-intel and 90 on macos-15-intel, and
with the real bundle it exceeds 120 on both Intel images every time. It has been
seen intermittently on developers' own machines for the same reason.

`hdiutil detach -force` is no help, which was worth finding out the hard way
since it is usually described as the escape hatch: it waits on DiskArbitration
as well, times out identically, and the conversion then fails with "Resource
temporarily unavailable" because the image is still attached.

`hdiutil create -srcfolder` builds the image directly from a directory and never
mounts a volume, so none of this can happen. Verified on both architectures
against a real Electron bundle: the image is created and verifies, and mounting
it read-only afterwards shows the volume named correctly with the .DS_Store,
the background directory, the volume icon and the Applications symlink all
present. hdiutil preserves that symlink rather than following it. Creation takes
107 seconds on arm64 and 312 on macos-26-intel, slower than before, but with no
fixed wall anywhere in it.

That also disposes of create-dmg, which was cloned unpinned from its default
branch on every build and run against the signed bundle. Since we passed
--skip-jenkins, none of its Finder automation ran and everything it did for us
was staging, all of which is now done directly. Its EULA template is vendored
into pkg/mac/ rather than cloned for one XML file, and the licence is attached
with udifrez exactly as create-dmg did.

Ruled out before arriving here: create-dmg's flags, the volume size, the file
count, Gatekeeper, Spotlight and the choice of runner image. A 400 MB image of
30,000 text files and one holding Electron and a Python framework unmount in
comparable time, so only the speed of the machine and the size of the bundle
move the number.

One thing CI cannot check is whether the volume icon and background actually
render, since that needs Finder. The DMG is kept as a build artefact so it can
be opened and looked at.
2026-09-16 12:03:20 +01:00
Dave Page cde8851993 Prototype replacing create-dmg with hdiutil create -srcfolder
The recovery added earlier does not work, and the run proved it plainly:

    Forcing detach of /dev/disk22...
    hdiutil: detach: timeout for DiskArbitration expired
    hdiutil: detach: drive not detached
    hdiutil: convert failed - Resource temporarily unavailable

So hdiutil detach -force waits on DiskArbitration exactly as the polite detach
does, same 120 seconds and same message, contrary to how it is usually
described, and the convert then fails because the image is still attached. That
was the one assumption I could not verify beforehand, the spike having never
reproduced the failure and its diagnostics therefore never having run.

hdiutil create -srcfolder builds the image directly from a directory and never
mounts a volume, so DiskArbitration is never involved and there is nothing to
detach. Since we pass --skip-jenkins, create-dmg does no Finder automation for
us anyway: what it actually provides is the volume name, an Applications
symlink, the background directory, the pre-built .DS_Store and a hidden
extension, all of which are staging. The two that are not are the volume icon,
which needs the custom-icon flag on the volume root, and the EULA, which is
attached to the finished image rather than placed inside it.

Rather than learn which of those survive through forty minute Intel builds,
test F stages a directory exactly as the replacement would and creates the
image from it, then mounts the result read-only to confirm the styling is
really there. Mounting a finished compressed image briefly is cheap; it is
unmounting a large populated read/write volume that is not.

The dead recovery code in _create_dmg stays put until this proves out, so it is
replaced in one change rather than reverted and then rewritten.
2026-09-16 12:03:20 +01:00
Dave Page 4d76b6190e Recover the macOS DMG build when hdiutil's unmount times out
create-dmg builds a read/write image, mounts it, populates it, unmounts it, and
only then converts it to the compressed image we ship. The unmount is the
fragile step: hdiutil waits on DiskArbitration with a fixed 120 second timeout
that nothing exposes a way to raise, and the cost of unmounting scales with the
bundle.

Measured on GitHub's hosted runners with an identical payload, unmount to "Disk
image done" takes about 20 seconds on arm64, 41 on macos-26-intel and 90 on
macos-15-intel; with the real bundle it exceeds 120 on both Intel images, every
time rather than occasionally. It has also been seen intermittently on
developers' own machines, which is the same problem with a smaller multiplier.

Retrying create-dmg would achieve nothing, since a deterministic failure just
recurs. What matters is that by the time the unmount fails the working image is
fully populated, and the only step create-dmg did not reach is the conversion.
So on failure we force the volume off, which does not wait on DiskArbitration,
and perform that last step ourselves. The result is verified rather than
assumed, because this path only runs when something has already gone wrong.

The successful path is untouched: when create-dmg returns 0 we return
immediately and none of this executes.

A fair amount was ruled out before landing here. create-dmg's flags, the volume
size, the file count, Gatekeeper, Spotlight and the choice of runner image were
each tested and each exonerated: a 400 MB image of 30,000 text files and one of
the same size holding Electron and a Python framework unmount in comparable
time, and only the speed of the machine and the size of the bundle move the
number.
2026-09-16 12:03:20 +01:00
Dave Page e49593d005 Actually remove the Spotlight step
The previous commit message said this was going and then didn't remove it.
Spotlight was ruled out two runs ago: the step demonstrably disabled indexing
and the detach failed exactly as before, so the comment above it claimed a
cause that had already been disproved.
2026-09-16 12:03:20 +01:00
Dave Page e7027e2186 Test file count as the driver of the DMG detach cost, and move Intel to macos-26
Tests C and D pinned the cost to something about a real bundle and, more
usefully, showed how differently the three runners handle it. Unmount to "Disk
image done", identical payloads: 19s on arm64, 41s on macos-26-intel, 82s on
macos-15-intel, against hdiutil's 120 second timeout, and that was with a
lighter stand-in than the real thing.

So the Intel QA job moves to macos-26-intel, which has roughly double the
headroom and is the newer image we would end up on anyway, macOS 15 being the
first to retire. The mdutil step goes at the same time: Spotlight was ruled out
two runs ago and leaving a step behind whose comment claims it fixes something
is worse than not having it.

What C and D could not separate is content type from file count, and the second
looks the more likely of the two. Test B held ~409 MB in 201 files and test D
~415 MB in a few thousand; the real bundle holds a comparable amount of data
across far more files, since web/ alone is 4,626 of them, 2,043 being .sql
templates, with docs/ adding 773 and site-packages and the Python stdlib on top.
Thirty thousand is a conservative estimate.

Test E therefore puts the same ~400 MB into 30,000 small text files with no
Mach-O content at all. If the unmount climbs, the driver is the number of files,
not Gatekeeper or LaunchServices inspecting binaries, and no amount of signing
or scanning policy would have helped. It also tells us whether macos-26-intel
survives a realistic file count, which decides whether the runner change above
is a fix or merely a stay of execution.
2026-09-16 12:03:20 +01:00
Dave Page 2d7e8aedb1 Bisect the macOS DMG detach failure down to the bundle
The first pass of the spike came back clean on all three runners, which is more
informative than it sounds. Bare hdiutil detached a 100 MB image in six seconds
and a 1.5 GB one in under a second, and create-dmg with pgAdmin's exact flags
and real assets over a 409 MB payload exited 0 in forty-four seconds, on the
very runner label where the real build has now failed three times out of three.

So it is not the runner image, not hdiutil, not create-dmg's invocation and not
the size of the volume. What is left is the bundle. Test B's stand-in was a
random blob in Contents/MacOS with no Info.plist and no Mach-O, which the system
does not regard as an application at all, whereas a genuine bundle landing on a
freshly mounted volume gets picked up by LaunchServices and Gatekeeper in ways a
folder of noise does not.

Test C is therefore a real Electron.app, which is precisely what the real build
starts from, and test D adds a relocatable Python framework on top, that being
the other symlink-heavy thing the build layers on and the reason
_prune_dangling_symlinks exists. Neither installs anything through pip, so this
stays in the region of ten minutes rather than the forty the real build needs on
Intel to compile cryptography.

If C fails we have it narrowed to real app bundles; if C passes and D fails, to
the Python framework.
2026-09-16 12:03:20 +01:00
Dave Page d5c71d7063 Add a spike workflow to diagnose the macOS DMG detach failure
Three Intel appbundle runs have now failed identically, always exactly 120
seconds after create-dmg starts unmounting, with the bundle otherwise complete
and verified; arm64 has passed four times through the same code, and disabling
Spotlight changed nothing. Reproducing it through `make appbundle` costs forty
minutes a go, nearly all of it compiling cryptography on Intel, which is a
miserable way to test a hypothesis.

So this reproduces the failing step directly, in a couple of minutes, and
answers three questions at once: whether plain hdiutil fails or only create-dmg
does, whether it depends on image size, and whether it is specific to the
macos-15-intel image. arm64 is included as the control that is known to work.

When something fails it captures evidence rather than leaving us guessing:
hdiutil's own view of what is attached, lsof against the volume, the processes
that typically hold one, the diskarbitrationd and hdiutil unified log for the
preceding few minutes, and whether a forced detach succeeds where the polite
one timed out. That last one should be the most telling, since it distinguishes
something holding a reference from DiskArbitration itself not answering.

The mdutil step added to check-macos-build.yml stays for now so the two runs
remain comparable; it should come out once we know the real cause.
2026-09-16 12:03:20 +01:00
Dave Page 68a5f7781f Disable Spotlight indexing for the macOS build checks
The Intel appbundle build fails at the very last step, every time rather than
intermittently: the bundle is assembled, _verify_bundle_linkage passes, the SBOM
is written, the disk image is created and populated, and then create-dmg cannot
unmount it.

    Unmounting disk image...
    hdiutil: detach: timeout for DiskArbitration expired
    hdiutil: detach: drive not detached

Two runs, identical failure, and the gap between the unmount starting and the
timeout is exactly 120 seconds, so something is waiting out a timeout rather
than racing. Spotlight indexing the freshly mounted volume is the usual cause,
holding a DiskArbitration reservation that the detach then sits behind, and
nothing on a build runner wants a Spotlight index anyway.

arm64 has never shown this, so the step is harmless there rather than needed.
If this doesn't settle it, the next thing to try is macos-26-intel, and after
that a retry around the detach, which would mean changing pkg/mac rather than
the workflow.
2026-09-16 12:03:20 +01:00
Dave Page 35f3615644 Restore yum-utils to the RPM build container
Dropped by accident when the compiler packages were added, and pkg/redhat's
build.sh shells out to yumdownloader at line 229, near the very end. So the
container built the docs, ran webpack, produced the RPMs, and only then died
with a bare exit 127 about twelve minutes in, which is a slow and unhelpful way
to learn that a package is missing.

Also check for yumdownloader explicitly once the packages are installed, so the
same class of mistake fails immediately and says what is wrong. That matters
beyond this one slip: the dnf5 distributions (EL 10, Fedora 41 and later) get
yumdownloader via yum-utils' compatibility shims rather than from yum itself,
which is the sort of thing that changes under us without warning.
2026-09-16 12:03:20 +01:00
Dave Page c82e8038ee Fix the unsigned Windows installer build, and install syft for it
Two problems, one of them in the packaging rather than the workflow.

installer.iss.in has always carried an unconditional `SignTool=pgAdminSigntool`,
but Make.bat only defines that SignTool when PGADMIN_WINDOWS_CSC is set. So the
unsigned path, which Make.bat explicitly supports and announces ("Skipping code
signing"), cannot actually produce an installer: ISCC aborts with "Value of
[Setup] section directive SignTool is invalid". It has presumably never been
exercised, because the Jenkins Windows job runs on the box with the token
plugged in, where the variable is always set.

Both signing directives are now inside `#ifdef SIGNED`, and the signing branch
of Make.bat passes /DSIGNED next to the existing /SpgAdminSigntool=. The signed
build emits exactly what it emitted before; the unsigned build now works.

Second, and more mundane, syft isn't on the hosted image. That one was silent:
:GENERATE_SBOM redirects syft's output into sbom.json and returns 0 whatever
happens, so a machine without syft ships an empty SBOM rather than failing. The
buildfarm's Windows worker installs it via Chocolatey, so this does too.
2026-09-16 12:03:20 +01:00
Dave Page 997b6c52f9 Statically link OpenSSL into cryptography for the Intel macOS build
cryptography publishes arm64-only macOS wheels (checked against 50.0.1), so on
macos-15-intel pip builds it from the sdist and its openssl-sys crate links
whatever OpenSSL it finds on the build host, which on a hosted runner is
Homebrew's. _fixup_imports deliberately skips _rust.abi3.so, so the reference
survives into the bundle and _verify_bundle_linkage stops the build:

    ERROR: .../cryptography/hazmat/bindings/_rust.abi3.so links against
    build-host libraries:
        /usr/local/opt/openssl@3/lib/libssl.3.dylib
        /usr/local/opt/openssl@3/lib/libcrypto.3.dylib

That's issue #10123 reproducing exactly, and the release build already guards
against it by setting OPENSSL_DIR and OPENSSL_STATIC against its own OpenSSL.
This does the same against Homebrew's, which leaves no external reference at
all. The arm64 job was unaffected throughout, since it gets a wheel.

Worth noting for scheduling: the Rust compile makes the Intel build roughly
twice the length of the arm64 one, 50 minutes against 27.
2026-09-16 12:03:20 +01:00
Dave Page b6627315b4 Install wget for the Windows build check
wget isn't on the hosted Windows image, and Make.bat's Electron download is an
unbounded retry loop (Make.bat:316), so the build doesn't fail, it just spins on
error 9009 until the job hits its timeout. The buildfarm's Windows worker has
wget from the same Chocolatey line in pkg/win32/README.md, which is where this
one now gets it too.
2026-09-16 12:03:20 +01:00
Dave Page f1681d78d3 Fix the DEB and RPM container builds
Two faults from the first run, neither of them deep.

All nine jobs would have hit the git ownership check: the container runs as
root whilst the workspace is owned by the runner user, so git refuses to touch
it, and `yarn run bundle` shells out to git for the commit hash and dies with
exit 128. The DEB builds got all the way through webpack before falling over on
that, which at least confirms the rest of the environment is sound. Marking the
workspace as a safe directory after checkout is the usual remedy.

The RPM builds failed earlier and more prosaically, with no compiler in the
container: psycopg-c and gssapi are both built from source, since
pkg/linux/build-functions.sh passes --no-binary psycopg, and rpmbuild wants
redhat-rpm-config. The buildfarm picks these up from the @development-tools
group; they're listed individually here to keep the container small. The DEB
side already had build-essential, which is why it got so much further.
2026-09-16 12:03:20 +01:00
Dave Page b55f5997dd Update the GitHub Actions to their latest major versions
The runner has started warning about Node.js 20 actions being deprecated, which
covers every first-party action we use, since v4 of checkout and upload-artifact
still run on the Node 20 runtime.

So: checkout v4 to v7, upload-artifact v4 to v7, setup-node v4 to v7,
setup-python v5 to v7 and docker/build-push-action v6 to v7. Nothing behavioural
changes for us. The intervening majors are almost entirely the Node 24 runtime
move, with checkout v6 persisting credentials to a separate file, checkout v7
refusing to check out a fork's head for pull_request_target and workflow_run
(neither of which we use), and upload-artifact v7 adding an opt-in unzipped
single-file upload.

One thing to be aware of before we stand up a self-hosted runner for the signing
builds: checkout v5 and later need runner 2.327.1 or newer, so that host will
have to be reasonably current.

The SonarQube action is left pinned to its commit hash, which is deliberate.
2026-09-16 12:03:20 +01:00
Dave Page d0ce7ad552 Add DEB, RPM, macOS, Windows and Helm build checks
These are the five QA builds that the Jenkins buildfarm still owns, and between
them they're the last thing standing in the way of retiring the QA half of it:
the container, tarball, wheel and documentation checks already run here.

The DEB and RPM builds run in a container per distribution on a hosted runner
rather than on a dedicated EC2 VM per distribution, which is the same build in
a reproducible environment and nine fewer machines to look after. The package
lists come from the buildfarm's own Ansible packages_build role. PGDG is
mandatory for RPM, because pkg/redhat/build.sh opens by globbing /usr/pgsql-1*
under `set -e` and dies without it; the DEB build is happy with the distro's
libpq-dev.

macOS builds on both architectures and is already proven: an earlier spike ran
it on macos-15 in 22 minutes with webpack peaking at 2991 MB against its 4096 MB
ceiling and no swap used at all, so the 7 GB arm64 runners have adequate
headroom. That spike workflow is removed here, superseded by the real one.

Windows runs on a hosted runner too, which wasn't obvious: signing in Make.bat
is conditional on PGADMIN_WINDOWS_CSC, so an unsigned build check needs neither
the Certum hardware token nor the machine it's plugged into, and only the
signing release builds need a self-hosted runner. Its dependencies come from
dpage/winpgbuild, the same place the buildfarm's winpgbuild-update job gets
them. This one hasn't had a successful run yet and should be expected to need a
few passes.

All five trigger on master and by hand, not on pull requests, matching what the
Jenkins jobs do today; whether the full matrix should also gate PRs is a
separate question.
2026-09-16 12:03:20 +01:00
Dave Page d486241b06 Add a throwaway spike workflow for the macOS appbundle build
We're assessing a move of the buildfarm to GitHub Actions, and the one thing
that isn't already proven by the existing workflows is whether the appbundle
build fits inside a hosted macOS runner. The arm64 images have 3 vCPU and 7 GB
of RAM against the 8 cores and 16 GiB of the mac2.metal worker they'd replace,
and pkg/mac/build-functions.sh:320 records webpack being OS-OOM-killed inside
TerserPlugin at a 3 GB old-space ceiling, with 6 GB then starving the earlier
steps. Nothing we currently run on macOS builds a production bundle, so that
history is untested on hosted hardware.

The workflow is workflow_dispatch only, builds unsigned (build.sh skips signing
and notarisation when the two conf files are absent, so it needs no secrets),
and samples resident set sizes and swap every ten seconds so the logs show
whether the machine actually ran out of headroom rather than just whether the
build happened to pass. The runner image, the Python version and the webpack
memory ceiling are all inputs, so the ceiling can be bisected across images.

To be deleted once the question is answered.
2026-09-16 12:03:20 +01:00
Ashesh Vashi f09776c22d test(backup, restore): fix stale XSS check after PGDATABASE dbname fix
Backup/restore now pass the target database via PGDATABASE instead of
a CLI/positional argument, so the XSS regression test's check against
the displayed command string could never find the db name (escaped or
not) and always failed. Point Backup's check at the message field,
where the db name is still interpolated; for Restore, where the db
name no longer surfaces anywhere (command shows an always-empty
--dbname, message omits it entirely), assert its absence instead.
2026-09-15 18:11:25 +05:30
Ashesh Vashi d64bc8c24c Updated message catalogs for v9.18
Also drop the fuzzy marker from the Korean catalog header. Babel skips a
catalog whose header is fuzzy, and ko's header still carried the
unfilled template placeholders that make babel mark it so, with the
result that ko/LC_MESSAGES/messages.mo had not been regenerated since
November 2025 -- 83KB against the 263KB the .po compiles to, so most of
the 89% of Korean strings that are translated never reached users.
2026-09-15 17:19:11 +05:30
Ashesh Vashi 1c66edd12d docs: cite a GitHub issue for every 9.18 release note entry
The file mixed issue-backed entries with commit-id ones. Make every
entry issue-backed:

  - The LLM API redirect hardening had no issue, and its entry was the
    only record of Ziya Abdullayev's report outside the commit message.
    It gets #10420, written up with the mechanism, the affected range
    (>= 9.15, since ALLOWED_LLM_API_URLS did not exist before then) and
    the fix commit, and noting that it is hardening rather than an
    exploitable flaw, so no CVE was requested.

  - The Table dialog fix closed two issues, #10179 and #10180, so it
    becomes two entries. That also covers the Definition-tab type
    restriction, which the single commit-id entry had omitted.

  - The remaining commit-id entries are dropped.
2026-09-15 17:02:00 +05:30
Ashesh Vashi 36e08d6d8a fix(maintenance): drop a duplicated comment block above the database guard
The four-line comment explaining why an empty database must be rejected
was pasted twice above the guard in create_maintenance_job(). Comment
only; no behaviour change.
2026-09-14 23:08:27 +05:30
hiteshjambhale 59f8d82aa9 fix(restore, maintenance): reject empty/missing database to close role-name fallback
The PGDATABASE fix only set the env var when the database value was
truthy, so an empty string left both PGDATABASE and --dbname unset.
libpq then falls back down its chain to a database named after the
login role, silently restoring into / vacuuming the wrong database
instead of failing. Reject an empty or missing database with a 400
before any args are built, in both tools, and add regression tests
covering the empty-value path.
2026-09-14 17:33:20 +00:00
hiteshjambhale 3922cdfcbf test(restore, maintenance): harden arg-injection guards per review
- Scan every argv token for the forbidden value (forbidden_arg_substr)
  instead of list-membership only, so a value smuggled into a single
  token (e.g. "--dbname=host=...") is caught.
- Assert pg_restore keeps the required "--dbname=" flag, guarding against
  a regression that drops it (pg_restore errors without -d/--dbname).
2026-09-14 17:33:20 +00:00
hiteshjambhale 038a2619fa test(restore, maintenance): add arg-injection regression tests; fix pg_restore --dbname display
- Add regression scenarios asserting the database value is absent from
  argv and carried in PGDATABASE (maintenance: 1, restore: 2). They fail
  if the fix is reverted.
- Use the attached form "--dbname=" (a single argv token) for pg_restore
  instead of ['--dbname', ''] so the process-details command renders
  correctly -- an empty standalone token was dropped from the display.
2026-09-14 17:33:20 +00:00
hiteshjambhale e3a10c53cb fix(restore, maintenance): pass database via PGDATABASE to close connection-string injection
The restore and maintenance tools passed the user-controlled database
value to --dbname. libpq expands a --dbname value containing "=" (e.g.
"host=evil port=5433 dbname=postgres") into a connection string, letting
a user redirect the connection -- and the exported PGPASSWORD credential
-- to an arbitrary server, regardless of the --host/--port pgAdmin sets.

Pass the target database via the PGDATABASE environment variable instead
(libpq treats it as a literal name and never expands it):
- maintenance (psql) and restore plain/SQL (psql): drop --dbname; the
  tool connects using PGDATABASE.
- restore custom/tar/directory (pg_restore): pg_restore requires
  -d/--dbname, so pass an empty --dbname '' (no "=", not expanded) while
  the real database name comes from PGDATABASE.
2026-09-14 17:33:20 +00:00
Ashesh Vashi cf22515efc Merge remote-tracking branch 'origin/master' into cve-9.18 2026-09-14 22:52:21 +05:30
Ashesh Vashi 81edb68b27 fix(deps): pin psycopg[c] back to 3.3.4 (#10399)
The macOS x64 packaging job fails while installing requirements.txt:

    Preparing metadata (pyproject.toml): finished with status 'error'
    error: subprocess-exited-with-error
    exit code: -10

Exit code -10 is SIGBUS. The only output before the crash is
setuptools' own `[tool.setuptools.ext-modules] in pyproject.toml is
still experimental` warning, so it dies while setuptools reads the
project config, well before pg_config is ever invoked.

psycopg-c ships no wheels, so every platform compiles it from the
sdist. The only build-tooling change between 3.3.4 and 3.3.5 is the
strictly pinned build requirement:

    3.3.0 - 3.3.4    setuptools == 80.3.1
    3.3.5            setuptools == 83.0.0

Because that pin is an equality, PIP_CONSTRAINT cannot override the
version inside the isolated build environment - the only ways to keep
3.3.5 are --no-build-isolation with a pre-seeded setuptools (which
would fork the macOS build procedure from Linux's) or an upstream
fix. Linux builds 3.3.5 fine, so this looks specific to the
relocatable-python framework the macOS bundle is built against.

Pin to 3.3.4 to unblock the build. The encoding.py rewrite that
shipped alongside the 3.3.5 bump stays untouched: it reads the
derived py_codecs/pg_codecs dicts, which are plain dicts in both
versions.

One test expectation was 3.3.5-specific. psycopg 3.3.5 added an
ISO88591 alias to its encoding table, so inverting py_codecs resolves
iso8859-1 to ISO88591; on 3.3.4 only LATIN1 exists, so
get_encoding('LATIN1') returns ['LATIN1', 'iso8859-1'] instead of
['ISO88591', 'iso8859-1']. Both are valid PostgreSQL names for the
same encoding, so the scenario now accepts either and the test passes
on 3.3.4 and 3.3.5 alike.
2026-09-14 22:46:45 +05:30
dev-hari-prasad fd9179f25a chore: configure 3-day release age gate for npm packages (#10390)
Set npmMinimalAgeGate to 3d in web/.yarnrc.yml and runtime/.yarnrc.yml to prevent immediately installing freshly-published packages, providing a grace period against npm supply-chain compromises.
2026-09-10 16:10:12 +01:00
dev-hari-prasad 6acbf875ae chore(security): restore checksumBehavior to throw in web and runtime (#10395)
Revert checksumBehavior from update back to Yarn's default (throw) in web/.yarnrc.yml and runtime/.yarnrc.yml to restore tamper detection and ensure builds fail if downloaded package checksums do not match lockfiles.
2026-09-10 16:10:05 +01:00
dev-hari-prasad 809e812a17 chore(security): disable install scripts by default and narrow approved git repos in /web (#10391)
Revert global enableScripts in web/.yarnrc.yml to Yarn's secure default (false) to prevent arbitrary lifecycle scripts from running on install. Allowlist only ttf2woff2 and unrs-resolver via dependenciesMeta.built in web/package.json, keeping promotional/unneeded scripts blocked. Narrow approvedGitRepositories to pgadmin-org/react-data-grid.
2026-09-10 16:09:54 +01:00
dev-hari-prasad d84d3ce9e3 chore(deps): pin and bump @fortawesome/fontawesome-free to 7.3.1 in /web (#10372)
Replace 'latest' with exact '7.3.1' in web/package.json and update web/yarn.lock.
2026-09-10 16:09:43 +01:00
Ashesh Vashi 155ebe5c28 docs: add assigned CVE numbers to the 9.18 release notes
Fill in the identifiers allocated by the PostgreSQL CNA for the three
security entries that carried a placeholder:

  #10383  webserver Remote-User auth bypass      CVE-2026-86863
  #10384  backup argument/conninfo injection     CVE-2026-86864
  #10385  File Manager save_file symlink follow  CVE-2026-86861

Add the missing entry for #10388, connection-string injection in the
Restore and Maintenance tools (CVE-2026-86862). The fix was written but
never got a release-note line.

Move the release date out to 2026-09-17.
2026-09-10 09:03:59 +05:30
Dave Page 153e3273d8 Fix inherited-column read-only state and Definition-tab type restriction in the Table dialog (#10332)
Backend properties fetch marks a column already inherited from a
parent table with inheritedfromtable, while a column fetched
interactively via 'Inherited from table(s)' carries inheritedfrom
instead and has no attnum yet. inSchemaWithColumnCheck only checked
inheritedfrom, and did so after an isNew() short-circuit that treated
the attnum-less interactive rows as new, so inherited columns ended up
editable and deletable in both cases. Check both fields, and check
them before the isNew() short-circuit, and extend
canEditDeleteRowColumns the same way so the row's edit/delete buttons
are disabled too.

Fix: restrict Definition-tab Data type options to edit_types (#10180)

The expanded row's Definition tab and the inline grid-cell editor each
defined their own copy of the edit_types filter for the 'cltype'
field, but the tab's version received the whole table's data as
'state' rather than the row, since MappedControl resolves a field's
'type' callback against the top-level schema, not the field's own row
(unlike 'cell', which already gets the full row). That made isNew()
and edit_types resolve against the wrong object, so the filter always
no-opped and the tab showed every type instead of the restricted set.

Have MappedControl also resolve a field's declared 'deps' against its
own row (listenDepChanges already does this correctly for 'cell') and
forward them as a 2nd argument to 'type', mirroring what 'cell'
already receives. column.ui.js declares 'edit_types'/'attnum' as deps
on 'cltype' and factors the filter into one shared editTypesFilter()
used by both 'cell' and 'type', so the two stay in sync by
construction.

Fx: honour inheritedfromtable in attlen/attprecision editable checks

The Length/Precision and Scale grid-cell editors only checked
inheritedfrom when deciding whether to allow editing, so a column
loaded with only inheritedfromtable set (i.e. already inherited when
the table was opened) could be left incorrectly editable, unlike the
other inherited-column checks in this schema. Add a shared
isInheritedColumn() helper covering both fields and reuse it in both
editable callbacks and in inSchemaWithColumnCheck.
2026-09-09 15:45:50 +05:30
Dave Page 6c70d7ccb8 fix(pkg): stop shipping the JavaScript build configuration (#10403)
The Windows installer and the pip wheel were both shipping web/yarn.lock,
web/package.json and the rest of the JavaScript build configuration into
the installed tree, even though none of it is used at runtime: only the
webpack output under pgadmin/static/js/generated is. Because node_modules
is stripped, the lockfile that remains describes packages that are not
present, so vulnerability scanners run against an installation report the
whole build-time dependency tree, devDependencies included, as findings
that cannot be acted on and will recur on every release no matter how
current the versions are.

The Linux, macOS and Docker builds already removed these files, so this
brings Windows and pip into line with them, and adds webpack.* to the
Linux and macOS lists so that all of the packagers now strip the same
set. For pip the cleanup runs before syft, so the SBOM describes what
actually ships.

Verified by assembling a web tree with the cleanup applied and starting
pgAdmin from it: /misc/ping and /browser/ both return 200 and every
generated bundle is served.
2026-09-09 14:37:38 +05:30
Dave Page 9d0a61a828 test: drop proc1 from the Schema Diff KNOWN_DIFFERENCES list
The whitespace-only difference that CREATE OR REPLACE left in procedure
bodies was fixed in abf926428, so proc1 now settles once the generated
script has been applied and the test fails on the stale entry, exactly
as it is designed to: the list fails when something on it starts working
so that it cannot quietly rot. Take the entry off.
2026-09-07 22:40:55 +01:00
dev-hari-prasad 50d76765a1 perf: defer the cloud SDK imports until a cloud wizard is used (#10362)
boto3, azure.*, googleapiclient and google_auth_oauthlib were imported at
the top of the AWS RDS, Azure and Google Cloud modules, so every pgAdmin
start paid for all three SDKs whether or not anyone went near the cloud
deployment wizards. Move those imports into the functions that need them,
leaving the blueprints, their menu entries and the exposed endpoint map
eagerly registered, which is the property that makes this viable where
the earlier lazy-blueprint idea was not; repeat calls cost nothing, since
sys.modules caches each module after the first import.

The modules with several call sites get a small _azure_sdk() or
_google_sdk() helper handing back the symbols in a namespace, whilst the
one and two site cases carry a plain inline import with a comment saying
why it sits there. The oauth2client sentinel stays at the top of the
Google module, where it still runs before anything can import
googleapiclient, and _google_sdk() now carries a note pointing back at it
so that a later tidy-up does not move it and quietly reintroduce #10110.

Deferring the imports moves the failure mode for a broken or missing SDK
from startup, where it is obvious, to the first click in a wizard, so
each affected path now fails cleanly rather than leaking a traceback into
the UI: the Google and Azure lookups return their usual (data, error)
tuple, or an empty list with the reason logged; Google.callback() reports
a missing google_auth_oauthlib as a verification error; and the RDS
client helper logs the ImportError and lets its callers answer with empty
metadata instead of a 500.

Also fixes a pre-existing bug in the Google instance_types endpoint,
which assigned the (instance_types, error) tuple returned by
Google.get_instance_types() to a single name and then called .get() on
it, raising AttributeError for anyone who got that far in the wizard.

Measured on Linux with a warm page cache, timing create_app() in desktop
mode over five runs and taking the median, this takes application startup
from around 1567 ms to around 1354 ms; on Windows the saving was reported
as larger, at around 2131 ms down to around 1515 ms.

Partially addresses #10221.
2026-09-07 15:59:36 +01:00
Ashesh VashiandDave Page 0b8e8db0cc fix(pkg): stop the Windows build overwriting the venv's pip (#10396)
* fix(pkg): stop the Windows build overwriting the venv's pip

CREATE_VIRTUAL_ENV creates a virtualenv and then copies the whole of the
system Python's Lib over it, so that the relocated interpreter has a
standard library to use. That copy includes Lib\site-packages, and XCOPY
/Y overwrites the files that exist on both sides without removing the
ones that only exist in the venv, so the venv's freshly seeded pip ends
up spliced together with whatever pip C:\Python313 happens to have.

That was harmless while the two layouts agreed. pip 26.2 turned
pip/_internal/build_env from a module into a package, so on a builder
whose system pip predates 26.2 the new build_env/ directory survives the
copy whilst utils/misc.py is overwritten by the older one, and every
subsequent pip invocation dies before it does anything:

  File "...\pip\_internal\build_env\installer.py", line 22, in <module>
    from pip._internal.utils.misc import get_runnable_pip
  ImportError: cannot import name 'get_runnable_pip' from
  'pip._internal.utils.misc'

It cannot recover on its own either, since the next line of the script
is the pip invocation that upgrades pip.

Copy the standard library with ROBOCOPY and exclude site-packages, which
the venv is entitled to keep to itself. ROBOCOPY rather than XCOPY
because /XD takes a directory to skip and the existing
:CHECK_ROBOCOPY_ERROR helper already handles its exit codes; /R:3 /W:5
so a locked file fails the build rather than retrying for a million
attempts.

* fix(pkg): make the Windows build's ROBOCOPY failures diagnosable

Follow-up review fixes to the site-packages exclusion.

Exclude site-packages by name rather than by full path. The full path is
built from PGADMIN_PYTHON_DIR, so if that is ever set with a trailing
backslash the source and the /XD argument both gain a doubled separator;
should the match then fail, site-packages is copied over the venv again
and the build fails with the same ImportError this was meant to remove.
No directory inside the standard library is legitimately called
site-packages, so matching by name is both simpler and unconditional.

Drop "> nul" from both ROBOCOPY calls in favour of /NFL /NDL /NP.
ROBOCOPY writes its errors to stdout, so with the redirect in place a
copy that returns 8 or more aborted the build with nothing in the log to
say which file or share was at fault; the switches suppress the per-file
noise whilst keeping the header, the summary and any errors.

Guard the copy of the web directory with "|| EXIT /B 1" as well, since
EXIT /B inside :CHECK_ROBOCOPY_ERROR returns from the label rather than
from the caller and a failed copy was therefore ignored, leaving the
build to package an incomplete tree.

Guard virtualenv.exe likewise: with the standard library now copied by
ROBOCOPY, which creates its destination, a failure there would otherwise
surface later at the activate step instead of where it happened.

---------

Co-authored-by: Dave Page <dpage@pgadmin.org>
2026-09-07 15:02:06 +01:00
Ashesh Vashi 0e9c3eab8f Add the master changes merged since the 9.18 notes were written
Covers the ten commits merged from master: the CSP per-request nonce,
the Object Explorer keyboard shortcut (folded into the existing #9631
entry, since it is the same feature reached another way), the Schema
Diff dependency ordering, function-body whitespace, foreign table and
sequence fixes surfaced by the now-asserting regression test, the
server-cursor prepare TypeError, the partitioned index TABLESPACE
clause, the UDF argument grid, the Helm existingSecret path and the
Validate binary path dialog.

Entries within each section are now ordered by issue number, with the
SHA-keyed ones last.
2026-09-07 16:50:01 +05:30
Ashesh Vashi 7edb9c012c Merge remote-tracking branch 'origin/master' into cve-9.18 2026-09-07 16:47:57 +05:30
Kundan 7c2177241f fix: render Validate binary path modal as HTML instead of raw markup (#10394)
The endpoint returned a pre-built <b>/<br/> HTML string, and the frontend
switched to the escaping alertText() during the XSS hardening pass
(9e370d3cb), so the modal showed literal tags instead of formatted text.
Return structured {utility, version} data from the backend and compose
the modal content as React elements on the frontend, keeping the
untrusted binary version output routed through SafeMessage.

- Fall back to the not-found message on empty version output too

|| instead of ?? — an empty-string version from an unexpected
'--version' output shape should still show the fallback message.
2026-09-07 16:46:41 +05:30
hiteshjambhale fb0ca5c4c8 feat: Use per-request nonce in CSP to remove 'unsafe-inline' / 'unsafe-eval' (#10308)
Harden the default Content-Security-Policy so inline scripts run only via a
per-request nonce instead of a blanket 'unsafe-inline', and drop 'unsafe-eval'.

- Generate a per-request nonce (secrets.token_urlsafe) cached on flask.g so the
  exact same value is emitted in templates and the CSP response header.
- Substitute a {nonce} placeholder in CONTENT_SECURITY_POLICY at runtime.
- Tag inline <script>/<style> tags, and set window.__webpack_nonce__ so webpack's
  dynamically injected assets carry the nonce too.
- New default: script-src 'self' 'nonce-{nonce}' (no 'unsafe-inline'/'unsafe-eval').
- style-src keeps 'unsafe-inline': MUI/React inject un-nonced runtime styles and
  inline style="" attributes that cannot be nonced.
- 'unsafe-eval' is not needed by production bundles; the dev ('eval' devtool)
  bundles add it via config_local.py (documented in config.py).

Setting window.__webpack_nonce__ in HTML is a no-op: webpack only substitutes the __webpack_nonce__ identifier inside compiled modules, and MUI/emotion does not read it either (it requires an explicit createCache nonce). Same-origin webpack chunks are already allowed by script-src 'self', so the block did nothing. Remove it; the resourceBasePath inline script keeps its nonce.

Development bundles are built with webpack's 'eval' devtool, which the strict nonce policy blocks, forcing developers to manually add 'unsafe-eval' via config_local.py. Handle it automatically in get_content_security_policy() (which runs per request and therefore sees a DEBUG value overridden in config_local): when config.DEBUG is set and the policy uses a nonce, append 'unsafe-eval' to the script-src directive, without duplicating it. Production is unaffected and custom (non-nonce) policies pass through untouched.

Adds unit tests covering nonce generation/caching/per-request freshness, {nonce} substitution, pass-through of custom/None/empty policies, header emission, and the dev-mode behaviour (including the no-script-src edge case, exact script-src name matching, and no-duplication).

The dev-mode 'unsafe-eval' behaviour is now implemented, so these are ordinary regression tests. Remove the 'PLANNED'/'EXPECTED TO FAIL until impl' banners (which incorrectly told maintainers not to make the source pass) and an unused MagicMock import.
2026-09-07 16:44:38 +05:30
Dave Page d0210a534d fix: correct existingSecret path in Helm deployment template (#10214) (#10313)
The annotation conditions referenced the non-existent top-level
.Values.existingSecret instead of .Values.auth.existingSecret, so the
secret checksum annotation and the empty-secret gating never worked as
intended when an existing secret wasn't supplied.
2026-09-07 16:42:50 +05:30
Dave Page 006fc6bd88 fix: omit redundant TABLESPACE pg_default from generated index SQL (#10342)
PostgreSQL rejects an explicit TABLESPACE clause naming the database's
own default tablespace when the index is on a partitioned table
('cannot specify default tablespace for partitioned relations'), so
the SQL pgAdmin generated for a new index could not be executed
against a partitioned table whenever no non-default tablespace was
chosen. The index_constraint and exclusion_constraint create.sql
templates already guard against emitting this redundant clause;
extend the same guard to the plain index create.sql templates.

Closes #10341
2026-09-07 16:42:15 +05:30
Dave Page abf926428e fix: stop Schema Diff injecting whitespace into applied function/procedure bodies (#10302) (#10317)
Generating a script for a function or procedure that only exists on the
source ("Source Only") routed through FunctionView.sql(), which always
calls reformat_prosrc_code() to wrap the body with a leading and trailing
newline around $BODY$...$BODY$ purely for readability in the SQL panel.
That reformatted body was then executed verbatim against the target, so
PostgreSQL stored the extra newlines in prosrc: the target's body no
longer matched the source's byte for byte, and re-comparing kept
reporting a whitespace-only difference unless "Ignore whitespace" was
ticked.

Schema Diff's update path (CREATE OR REPLACE against an existing target
object) already suppressed this formatting via allow_code_formatting,
added for #7102; this extends the same guard to the create/"Source
Only" path so Schema Diff never adds whitespace of its own to the SQL
it actually applies.

Added a dedicated regression test covering both the "Source Only" and
"Different" cases for a function and a procedure: applying the
generated script now leaves every object comparing as Identical
without needing "Ignore whitespace".
2026-09-07 16:41:35 +05:30
Dave Page f2fdef5ba5 Schema Diff: reinstate dependency ordering of the generated script (#10319)
dependLevel drove the order in which generateFinalScript() writes
objects, with higher levels emitted first so dependencies land before
whatever needs them, but nothing has assigned it since the React port
deleted schema_diff_dependency.js: every row got Object.keys' default
undefined bucket, so the script came out in whatever order the rows
happened to be in.

computeDependLevels() rebuilds the levels for the full result set from
each row's dependencies, walking the reverse graph so a row that other
rows depend on always ends up with the highest of their levels plus
one, with a cycle guard for the circular dependencies the script header
already warns about.

Fixes #10295.
2026-09-07 16:40:27 +05:30
Dave Page 972332ae59 feat: add a keyboard shortcut for collapsing the Object Explorer (#10296)
#10254 made the Object Explorer collapsible by clicking the current
workspace icon, but left that as the only way to do it. This adds a
shortcut, Ctrl+Alt+B by default, registered as its own
toggle_object_explorer preference so anyone can change it.

Ctrl+Alt+B rather than anything in the Shift+Alt family, which is full: b,
f, o, l, h, q, v, s, n, e, d and g are all taken, b by the existing Object
Explorer shortcut, which keeps its meaning of focusing the tree. Ctrl+Alt+B
is close enough to VS Code's Ctrl+B for the side bar to be guessable, and
keeps a family resemblance to the bracket keys used for tab navigation.
Ctrl+Shift+B would have been the other obvious candidate, but Chrome and
Firefox both use it for the bookmarks bar.

Worth noting for anyone reviewing: on keyboard layouts where AltGr is
Ctrl+Alt, this combination can be swallowed by the layout and produce a
character instead. That is true of any Ctrl+Alt binding, the preference is
user-configurable, and Shift+Ctrl+Alt+B is available if the default turns
out to annoy people.

The shortcut itself only fires an event, since the workspace provider owns
the visibility state, and the provider ignores it in classic layout where
there is no workspace toolbar and the Object Explorer is always shown.

Tested in a browser as well as in the unit tests: from the workspace layout
the key collapses and restores the panel, and the preference is registered
alongside the existing shortcuts.
2026-09-07 16:39:33 +05:30
Dave Page bc04db39d5 fix: stop AsyncDictServerCursor forwarding prepare to the server cursor (#10343)
psycopg's AsyncServerCursor.execute() has never accepted a prepare kwarg
(a server-side DECLARE CURSOR can't be a prepared statement) and raises
TypeError on any unexpected keyword, even one whose value is None.

PR #10030 widened AsyncDictCursor.execute()/_execute() to forward
prepare/binary to whatever cursor it holds, fixing a real
psycopg_pool.ConnectionPool.check_connection breakage. AsyncDictServerCursor
inherits that same execute()/_execute() without overriding it, so every
server-cursor query now unconditionally forwards prepare=None straight into
AsyncServerCursor.execute() and fails with
"TypeError: keyword not supported: prepare".

That TypeError isn't a psycopg.Error, so execute_async()'s
"except psycopg.Error" doesn't catch it. It propagates into the background
QueryThread's generic exception handler, which logs it and builds an
internal_server_error response that is discarded (the thread's return value
goes nowhere) - so the query silently never runs, invisible to the user,
and the async cursor is left with no query having actually executed on it.

Give AsyncDictServerCursor its own _execute() that drops prepare before
delegating, leaving DictCursor/AsyncDictCursor's forwarding for the
pool-checkout case it was written for untouched.

Strengthen test_server_cursor.py's existing scenario to assert the poll
response's actual status/result instead of only the HTTP status code and
the echoed server_cursor flag, and add a fast, DB-less regression test
asserting AsyncDictServerCursor._execute never forwards prepare.
2026-09-07 16:38:46 +05:30
Dave Page 3d310d4656 Fix UDF/procedure argument grid delete (and add) in edit mode (#10333)
`canDeleteRow for the function/procedure Arguments grid checked whether the
whole function was new rather than whether the individual row was new,
so once a function was saved the delete icon was disabled for every
argument row, including ones added but not yet saved (same bug pattern
already fixed for enum values in #8208). canAdd had the same whole-object
gate, hiding the "+" button entirely once a function was saved, so there
was no way to add a row in the first place.

Pre-existing (already persisted) arguments remain non-deletable, since
PostgreSQL has no way to remove an argument from a function via
CREATE OR REPLACE.

Also fixes _update_arguments_for_get_sql, which only merged the
'changed' key of the arguments diff and silently dropped (or, without
a 'changed' key at all, raised a 500) any newly added argument, so a
row added via the now-enabled "+" button actually survives into the
generated SQL.

Closes #10252
2026-09-07 16:37:12 +05:30
Dave Page 8c6fd211a7 Schema Diff: make the regression test assert its generated script, and fix what that found (#10305)
The Schema Diff comparison test wrapped applying its generated script, and
the comparison that follows it, in a bare `except Exception` that discarded
both. It reported a pass whatever the script did, which is why it printed
`syntax error at or near ")"` on every run whilst claiming two tests passed.
It now fails when an object's SQL does not apply, and when applying the lot
leaves the two databases different, with a short list of the differences
that are known not to settle yet so that the list cannot quietly rot.

Objects are applied one at a time and retried rather than as a single
script, because the script is no longer ordered by dependency (#10295), so
an object can fail purely because something it needs comes later on;
retrying tells that apart from SQL that is simply wrong.

Turning the assertions on found the following, each of which is fixed here:

* A range type being dropped and recreated because its kind changed lost
  its subtype, because directory_diff() drops a plain value that only one
  side of the comparison has, and rendered `CREATE TYPE ... AS RANGE ()`.
  Once that was fixed it wrote the catalogue's `-` placeholder out as
  `CANONICAL = -`, which the reverse-engineered SQL path already avoids.
  Both are now handled where the comparison data is built (#10304).

* The constructor functions, casts and multirange types that PostgreSQL
  creates for a range type were compared as though a user had written them,
  so the script tried to recreate objects that come into being with their
  parent type: 47 of 151 objects in the test's fixtures were these.
  Internal dependencies are now excluded alongside extension ones, matching
  what pg_dump does.

* Recreating a foreign table declared any column that also differed twice,
  because a changed column was appended to the table's existing columns
  rather than replacing the entry already there (#10297).

* Raising a sequence's MINVALUE above the value it currently sits at, or
  lowering MAXVALUE below it, generated a statement PostgreSQL rejects
  outright, taking every other change to that sequence with it. Such a
  change is now accompanied by the RESTART it requires (#10298).

* A foreign table column added by Schema Diff lost its collation, because
  get_columns.sql calls it collname whilst the column templates render
  collspcname (#10300).

* A comparison that threw part way through emitted its failure and then
  reported success as well, handing the client a fraction of the databases
  as though it were a complete result (#10303).

Two differences remain listed as known: a rebuilt partitioned table keeps
the default partition used as scaffolding for the data copy (#10301), and
CREATE OR REPLACE wraps a function body in newlines, leaving a
whitespace-only difference (#10302).

Fixes #10293

* Stop the partition rebuild script copying from a temporary table

Asserting that the generated script actually applies turned up a
partitioned table rebuild whose script refers to a relation that has
never existed, along the lines of:

    CREATE TABLE schema.temp_partitioned_2 (
        LIKE schema.temp_partitioned_1 INCLUDING ALL
    ) PARTITION BY RANGE (col1);

so that applying it fails with 'relation "schema.temp_partitioned_1"
does not exist'.

There are two things going on here, and both are fixed.

PgAdminModule.register() is called once per application instance, whilst
the blueprint objects themselves are module level singletons, so each
sub-class that appends its sub-modules from its own register() (most of
them do, TableModule included) leaves a duplicate entry behind every
time a second application is created in the same process. Nothing in
production notices, because production creates a single app, but the
regression suite creates several, and anything walking self.submodules
then does its work once per duplicate: with four copies of the partition
sub-module, get_sql_from_submodule_diff generated the same partition
rebuild four times over. self.submodules is now de-duplicated as the
blueprint registers, and parentmodules likewise only gains an entry it
does not already hold.

The second call was only harmful because PartitionsView.get_sql_from_diff
stashed its temporary names on the caller's own dictionaries, replacing
the table's real name with a temporary one, so a subsequent call read the
first call's temporary name back as the original. It now works on copies
and leaves the comparison data it is handed alone, which makes it safe to
call more than once regardless of how it is reached.

* Take a mutable copy of request.form, and close cursors on a failed chunk

Two things picked up in review.

Sequence update() passed request.form straight through to get_SQL(), and
request.form is immutable, so as soon as _add_restart_for_new_bounds had
a restart to add (which is the whole point of it) a form encoded update
raised TypeError. It now takes a dict copy, as the msql path already
effectively did.

apply_sql_chunks() left the cursor open when a statement failed, and a
failed statement is retried on the next pass, so a run could accumulate
one open cursor per attempt. The cursor is now closed in a finally,
whether the statement worked or not.
2026-09-07 16:35:13 +05:30
Ashesh Vashi de71c83d8d Bump version to 9.18 and add the 9.18 release notes
Update APP_REVISION/APP_VERSION_INT in web/version.py and the Helm
chart's version/appVersion, and add docs/en_US/release_notes_9_18.rst
with a toctree entry.

The notes cover everything merged since REL-9_17 (ee7109d40..bd7cde585)
plus the three CVE fixes on this branch: the Webserver auth header
bypass (#10383), Backup argument and connection-string injection
(#10384) and the File Manager save_file symlink TOCTOU (#10385). The
CVE identifiers are still placeholders (CVE-2026-XXXXX) pending
assignment, and #10388 has no entry because its fix is not on this
branch yet.

Changes with no associated issue are listed under Housekeeping and Bug
fixes keyed by commit SHA, following the 9.15 convention, so the
"Additional changes" wrapper is dropped and Dependencies becomes a
top-level section.
2026-09-07 15:02:01 +05:30
Kundan SableandClaude Sonnet 5 8ed0ecc06b webserver auth: address round-3 review follow-ups
Two non-blocking items from asheshv/pgAdmin4-cve#66's approval review:

- The auth_source lockout remedy was circular for the deployments most
  likely to hit it: telling a locked-out admin to "sign in through
  another authentication source" doesn't help when
  AUTHENTICATION_SOURCES = ['webserver'] and there is no other source.
  Documented the actual way out - temporarily add 'internal' back,
  fix the affected users, remove it again.
- A malformed WEBSERVER_REMOTE_USER (not a non-empty string) was
  demoted to info logging along with the client-triggered rejections
  in the previous round, but it's a static operator misconfiguration,
  not something a client varies per request - at info it would go
  unnoticed while every header-based login silently fails. Moved back
  to warning, consistent with the other config-error checks.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-04 19:06:51 +00:00
Kundan SableandClaude Sonnet 5 c0bd0d8665 webserver auth: fix CI-breaking test isolation bug, address round-2 review items
Round 2 of asheshv/pgAdmin4-cve#66's review:

- test_webserver_remote_user_trust.py bound WebserverAuthentication at
  module-import time. test_auth_gating.py (which sorts and runs first)
  evicts pgadmin.authenticate.webserver from sys.modules to observe its
  re-import and never restores it, so the trust test held a discarded
  copy of the module while patch('...webserver.User') patched the fresh
  one - the patch silently missed and hit a real, unconfigured database.
  Reproduced the reviewer's "27 passed, 3 failed" package-level run, then
  fixed it by importing WebserverAuthentication inside each runTest()
  instead, matching this repo's existing deferred-import convention.
  Full authenticate package now passes 30/30.
- Documented the auth_source lockout: login() refusing any non-webserver
  auth_source protects existing accounts, but a site with pre-existing
  internal-auth users (including the default admin) will find nobody can
  log in after enabling this. Added a warning to webserver.rst with the
  fix (change Authentication source in User Management).
- login()'s user-is-None branch called logger.exception() with no active
  exception, writing a useless NoneType traceback and never naming the
  failed username. Now a plain warning naming it.
- Demoted per-request rejection logging (untrusted peer, secret mismatch,
  misconfigured name) from warning to info, since an unauthenticated
  client can trigger any of them on every request; kept genuine config
  errors (a malformed WEBSERVER_TRUSTED_PROXIES entry, or the whole
  setting not being a list/tuple) at warning.
- Guarded against WEBSERVER_TRUSTED_PROXIES being set to a plain string,
  which iterated character-by-character and logged one warning per
  character while still safely rejecting the request.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-04 19:06:51 +00:00
Kundan SableandClaude Sonnet 5 90e94da9db webserver auth: address CVE fix review comments
Fixes four issues from asheshv/pgAdmin4-cve#66's review:

- HTTP_-prefixed WEBSERVER_REMOTE_USER names (e.g.
  HTTP_X_FORWARDED_USER) were permanently unresolvable via the header
  path: Werkzeug normalizes '_' to '-' in header lookups but does not
  strip the HTTP_ prefix. Normalize the name to its header form before
  looking it up.
- A non-str/bytes or non-ASCII WEBSERVER_SHARED_SECRET made
  hmac.compare_digest raise, turning every login attempt into an
  unhandled 500. Encode both operands and catch the failure, degrading
  to a rejected match with a logged warning instead.
- Added a test exercising the real ProxyFix/X-Forwarded-For bypass via
  app.test_client(), which the existing scenarios (bare
  test_request_context, no ProxyFix in the stack) could not catch.
- Added positive-path tests for login() (a genuine WEBSERVER user still
  logs in; a header-asserted name with no matching User row fails
  gracefully) plus a few low-priority coverage gaps the review flagged.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-04 19:06:51 +00:00
Kundan SableandClaude Sonnet 5 02e327c1b9 Fix authentication bypass in Webserver auth via client-controlled header
WebserverAuthentication.get_user() fell back to request.headers when the
WSGI environ lookup missed, letting any client set Remote-User (or an
equivalent HTTP_-prefixed/hyphenated name) and log in as an arbitrary
existing user, including an Administrator, with no credential check.

Gate the header fallback behind an explicit opt-in
(WEBSERVER_REMOTE_USER_FROM_HEADER), a trusted-proxy IP/CIDR allow-list
(WEBSERVER_TRUSTED_PROXIES, checked against the raw pre-ProxyFix peer so
X-Forwarded-For can't spoof it), and an optional shared secret
(WEBSERVER_SHARED_SECRET). Also refuse to log a header-asserted identity
into any account whose auth_source isn't webserver, so a forged header
can never take over an internal-auth admin even if the gate above is
misconfigured.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-04 19:06:51 +00:00
hiteshjambhale 5082834a27 fix(backup): pass database via PGDATABASE env to close connection-string injection
The "--" end-of-options marker (previous commit) stops pg_dump from
reading the database value as an option, but libpq still expands a dbname
containing "=" (e.g. "host=evil port=5433 dbname=postgres") into a
connection string -- letting a user redirect the connection, and the
exported PGPASSWORD credential, to an arbitrary server.

Pass the target database via the PGDATABASE environment variable instead
of as a command-line argument (as import_export already does). libpq
treats PGDATABASE as a literal database name and never expands it, so
both the file-write and connection-redirect vectors are closed. Also
fixes a latent bug where a database name legitimately containing "=" was
broken.

Update the regression tests: assert the database name is absent from
argv and carried in PGDATABASE (order-blind assertIn is insufficient).
2026-09-04 13:57:13 +00:00
hiteshjambhale a14469290e test(backup): add regression tests for database-field argument injection
Adds two scenarios to the object-backup unit test:
- normal dbname lands as the trailing positional after '--'
- a malicious '--file=...' value stays a trailing positional after '--'
  and never overrides the storage-confined '--file'

Uses an order-sensitive assertion on the last args (the existing assertIn
harness is order-blind and would pass even if '--' came after the dbname).
2026-09-04 13:57:13 +00:00
hiteshjambhale 82a88b74f9 fix(backup): prevent argument injection via database field
The object-backup path appended the request 'database' field to the
pg_dump argv as a raw positional argument. Under getopt_long argument
permutation, a value like --file=/absolute/path is parsed as an option
and overrides the storage-confined --file, letting a low-privilege user
write pg_dump output outside their storage sandbox.

Insert the '--' end-of-options marker before the database name so
pg_dump always treats it strictly as the positional dbname.
2026-09-04 13:57:13 +00:00
Ashesh Vashi d773db699f test: make save_file symlink test harness-native, add positive control
Follow-up to the previous commit; the fix itself is unchanged.

The new test called create_app() inside runTest(). That is redundant --
runtests.py already calls setApp()/setTestClient() on every test object,
independent of setUp() -- and expensive: it did not complete in over two
minutes locally, while the two existing tests in this file run in 1.1s
total. It also routes through create_app_data_directory(), which calls
sys.exit(1) on any data-directory problem, surfacing as SystemExit
mid-test. Use the harness's already-authenticated test client instead,
which also removes the save_file.__wrapped__() unwrapping; that worked
only because pga_login_required applies @wraps outermost over
@mfa_required, so reordering those two lines would have silently pointed
__wrapped__ at the MFA wrapper.

The old test also stubbed check_access_permission to a no-op, which
tests the write guard with the containment check absent rather than the
actual threat. Let the real check run and plant the symlink from inside
it, which reproduces the check-to-open race deterministically.

Assert on the error message rather than a bare status code. 500 is also
returned by the check_access_permission branch, and "outside file
unchanged" holds whenever any error occurs, so the previous assertions
would pass even if the write never happened for an unrelated reason.

Add a positive control. Nothing asserted that an ordinary save still
succeeds, so a broken _open_upload_target() would have left the negative
test green while every Query Tool and ERD save failed. It also pins the
0o600 mode so that documented behavioral change cannot regress silently.

Report the leaf-symlink rejection specifically instead of leaking the
raw strerror. A user whose save is refused saw "Error: Too many levels
of symbolic links", which explains nothing. Note this is a real
behavioral change: a symlink inside the storage root pointing at a
target inside the storage root passed check_access_permission and used
to work, and is now refused -- the same tradeoff already accepted for
uploads.

Verified with runtests.py against PostgreSQL 18.6 in desktop mode:

  --pkg misc.file_manager            19/19 pass
  --exclude feature_tests            2037 pass, 491 skipped, 1 failure

The single failure is utils.driver.psycopg3 test_encoding (LATIN1 maps
to the iso8859-1 python codec), which reproduces identically on the
unmodified base commit bd7cde585 and is unrelated to this branch.

Both new tests were confirmed non-vacuous by reverting the
_open_upload_target() call to the bare open(): TestSaveFileRejectsLeafSymlink
then fails with "AssertionError: 200 != 500" (the symlink is followed and
the outside target is overwritten) and TestSaveFileWritesRegularFile with
"AssertionError: 420 != 384" (0o644 vs 0o600).
2026-09-04 05:55:58 +00:00
Dave Page 83a31a350c fix: close save_file() leaf-symlink TOCTOU in File Manager
check_access_permission() resolves symlinks via realpath() and validates
containment (CVE-2026-7813), but save_file() re-joins the path afterwards
and wrote through a bare open(), which follows a symlink planted at the
leaf between the check and the write. The upload endpoint already closed
this exact gap with _open_upload_target()'s O_NOFOLLOW-protected open;
save_file() never got the same treatment.

Route save_file()'s write through _open_upload_target() too, so both
File Manager write sinks share the same kernel-enforced protection.
Reported privately per SECURITY.md.
2026-09-04 05:55:58 +00:00
Ashesh Vashi bd7cde5851 chore(deps): bump third-party JS and Python dependencies (#10370)
JS (yarn, patch/minor only): babel toolchain, MUI, react/react-dom,
testing-library, axios, webpack ecosystem, jest, eslint plugins, and
misc small libs. Excluded @simonwep/pickr (webpack prod-bundle
interop break on 1.10.x), @testing-library/user-event@14.6.7 and
webpack@5.110.3 (both npm-quarantined at bump time).

Python (>3.9 requirements branch only, Python 3.9 pins untouched):
Authlib 1.8, google-auth-oauthlib 1.4.1, gssapi 1.12 (ungated),
psycopg[c] 3.3.5, selenium 4.48.0, testscenarios 0.7.0.

Skipped: paramiko 3->5 (blocked on sshtunnel's paramiko.DSSKey
usage), azure-mgmt-resource 26.0.0 (drops Python 3.9 support and
conflicts with the <26 upper bound kept for Azure CLI distro
packaging, see #10247).

Two bumped packages required source fixes:

- psycopg 3.3.5 restructured the private
  psycopg._encodings._py_codecs attribute from a dict to a tuple of
  alias groups, breaking our monkeypatch in
  pgadmin/utils/driver/psycopg3/encoding.py with TypeError: 'tuple'
  object does not support item assignment. Rewrote get_encoding()/
  configure_driver_encodings() to use the derived py_codecs/
  pg_codecs dicts instead, which stay plain dicts across psycopg
  3.2.x-3.3.5 regardless of _py_codecs's internal shape. Verified
  byte-for-byte identical behavior against 3.3.4 for every
  encode_dict entry (SQL_ASCII, EUC_TW, UNICODE, ascii) plus
  UTF8/LATIN1. Added a DB-free unit test
  (pgadmin/utils/driver/psycopg3/tests/test_encoding.py) so a future
  psycopg internals change fails fast here instead of only surfacing
  as an app-wide import crash in the full regression suite.

- react-frame-component 5.3.2 breaks LayoutIframeTab.jsx (the iframe
  wrapper every tool panel - Query Tool, Debugger, PSQL, ERD, Schema
  Diff - renders into): the panel's iframe never mounts, hanging any
  of those tools indefinitely (React error #130 in the production
  bundle). This caused every run-feature-tests-pg CI job to fail.
  Reverted to 5.2.6.
2026-09-03 14:58:04 +05:30
Dave Page bc58657d3d ci: stop fetching an unpinned Yarn before the pinned one (#10306)
Everywhere we build the JS, we asked Yarn to install itself twice:

    yarn set version berry
    yarn set version <the version from packageManager>

The first call fetches whichever release is "berry" today and the second
immediately replaces it, so every build made two downloads to end up with one
Yarn, and the one that could not be reproduced tomorrow was fetched first.

That first fetch broke CI outright on 17 August 2026, during a GitHub
incident, when it returned an empty body and Yarn 1 died writing it out:

    error TypeError [ERR_INVALID_ARG_TYPE]: The "data" argument must be of
    type string or an instance of Buffer, TypedArray, or DataView
        at writeFile (node:fs:2373:5)

The unpinned call is dropped everywhere it appeared: Make.bat, the macOS and
pip package builds, and the four workflows. The packaging scripts keep their
pinned "yarn set version ${YARN_VERSION}", which still reads packageManager
from package.json, so their behaviour is unchanged beyond losing a download.

The workflows go further and use Corepack, which reads packageManager itself
and provisions exactly that Yarn without writing .yarnrc.yml and
.yarn/releases into the repository root, where the JS project is not. The
Dockerfile already installed and enabled Corepack immediately before both
"set version" calls, so both were redundant there and are simply removed.

CONTRIBUTING.md and README.md already tell contributors to start with
"corepack enable", so this brings the automation in line with the documented
setup. Note that Corepack ships with Node.js only up to (but not including)
25.0.0, so it will need installing explicitly once the runners move past it,
as the Dockerfile already does.
2026-08-21 18:39:32 +05:30
Dave Page 5bd4f3bde6 Javascript dependency: Bump use-resize-observer from 9.1.0 to 10.0.0 (#10265) (#10299)
v10 removes the default export in favour of a named one, so the import in
PgTreeView had to change with it; left as it was, useResizeObserver resolves
to undefined and the Object Explorer dies when the hook is called. The rest of
the v10 changes cost us nothing: it drops the /polyfilled entrypoint and its
@juggle/resize-observer dependency, no longer takes react-dom as a peer, and
requires React >= 18.2, which is comfortably met on React 19. The hook still
returns the { ref, width, height } shape the tree destructures.

Verified by hand in Chrome and Safari with the tree expanded through
databases, schemas, tables and tablespaces, resizing the panel and the window.
2026-08-21 18:37:43 +05:30
Dave Page 9a009fd2b6 Don't follow HTTP redirects on LLM API requests (#10281)
* Don't follow HTTP redirects on LLM API requests

ALLOWED_LLM_API_URLS is checked against the URL pgAdmin is configured
with, but the providers then issued the request through
urllib.request.urlopen(), whose default handler would follow a Location
header on to a destination that check was never applied to.

No legitimate LLM API replies with a redirect, so refuse them outright
rather than re-validating each hop: urlopen_no_redirect() installs a
handler that raises HTTPError instead, and the outbound calls in all
four providers and in the model-refresh endpoints now go through it.

This is hardening rather than a fix for an exploitable flaw, since
returning the redirect in the first place requires control of a host
that is already on the allowlist. Reported by Ziya Abdullayev.

* Handle 308 redirects on Python 3.10 as well

HTTPRedirectHandler only gained http_error_308() in Python 3.11, so on
the 3.9 and 3.10 interpreters we still support (and which CI runs) a 308
was never recognised as a redirect: it bypassed _NoRedirectHandler's
redirect_request() entirely and surfaced from http_error_default() as a
bare 'HTTP Error 308: Permanent Redirect'. The redirect was still not
followed, so this was never a security gap, but the caller got no
explanation of why the request had failed, and the test asserting our
message failed on every CI job as a result.

Mapping http_error_308 onto http_error_301, exactly as 3.11 itself does,
routes 308 back through redirect_request() so that every redirect status
behaves identically on every version we support.
2026-08-21 18:37:15 +05:30
Dave Page 1f02466324 fix: reject empty or null Username on non-shared server import (#10309) (#10320)
validate_json_data() only checked that the Username key was present on
a non-shared server, not that it held anything useful, so an empty or
null value imported cleanly and left behind a server that libpq would
silently authenticate as the OS account running pgAdmin rather than
reject outright. Check the value, matching the truthiness check already
used for shared servers and the "Username must be specified" rule
enforced by the server dialog.
2026-08-21 18:35:35 +05:30
Dave Page c0fa2a18d8 Relax azure-mgmt-resource pin to allow 24.0.0 (#10323)
The exact ==25.0.0 pin was an incidental side effect of a mass
dependency bump and isn't required by pgAdmin's own code: the cloud
wizard only uses the top-level ResourceManagementClient re-export and
resource_groups.list(), both unchanged between 24.0.0 and 25.0.0.
Pinning to >=24.0.0,<26.0.0 lets distro packagers keep pgAdmin
installable alongside Azure CLI, which still requires
azure-mgmt-resource<25.

Closes #10247
2026-08-21 18:34:55 +05:30
Dave Page 46c092cc5d Remove redundant passlib pin that conflicts with libpass (#10325)
Flask-Security-Too >= 5.7 depends on libpass, a fork of passlib that
installs its files under the same passlib/ import path. Our own
unconditional passlib==1.* pin in requirements.txt therefore causes
both packages to be installed into the same site-packages/passlib/
directory, and parallel installers such as uv can end up with a
mixed or overwritten set of files depending on install order.

pgAdmin's own code never imports passlib directly, and the older
Flask-Security-Too 5.6.x branch (used on Python 3.9) already pulls in
real passlib as its own transitive dependency, so dropping our direct
pin does not change what gets installed there. On newer Python
versions, only libpass is installed, resolving the conflict.

Closes #10239
2026-08-21 18:34:06 +05:30
Dave Page f739036066 fix: guard PasswordExec against None host/port/username (#10326)
Service-only connections (pg_service.conf) leave host, port and username
unset, so a per-server Password Exec Command crashed in get() with
TypeError: replace() argument 2 must be str, not None. Fall back to an
empty string for each unset placeholder instead.

Closes #10237
2026-08-21 18:33:16 +05:30
Thomas Han 0ebefaf80e fix: accept SharedUsername when importing shared servers (#9971)
Importing a servers.json definition insisted on a Username attribute for
every server, so a shared server that carried only SharedUsername was
rejected with "'Username' attribute not found for server ...", even though
the dialog treats SharedUsername as the default username for a shared
server. Validation now accepts either attribute when the server is shared,
whilst non-shared servers still require Username.

The loader derives the username it stores in the same way. Username wins
when both are present, since it is the owner's own login and the per-user
override, and SharedUsername is used when Username is absent. That matches
what creating a shared server through the dialog produces, so an imported
shared server prompts for a password on the first connection rather than
sitting on a loading spinner with no username to connect with.
SharedUsername itself does not inherit a legacy Username, because it means
"the default username for the other users of this server" rather than a
fallback for the owner.

Folded in during review:

Validation now looks at the values rather than merely at the keys. Checking
for the presence of a key alone let {"Shared": true, "SharedUsername": null}
and its empty-string equivalent through, and the loader would then store
that as the server's username: on a schema created from the model that is an
integrity error surfaced as a raw "Error creating server" string, whilst on
a database migrated over the years, where the column carries no NOT NULL, it
imports silently and leaves behind a server that cannot connect. The
equivalent pre-existing hole on the non-shared path, where {"Username": ""}
is still accepted, is left for a separate change covering empty usernames in
general.

Tests in web/pgadmin/utils/tests/test_validate_json_data.py cover the
username requirements for shared and non-shared servers, the Service escape
hatch, the integer port check, and shared servers being skipped rather than
rejected for a non-admin user. The JSON format documentation notes that
SharedUsername may stand in for Username.

Fixes #9226
2026-08-18 10:11:58 +01:00
hiteshjambhale 104d018677 fix: dedupe concurrent getNodeAjaxOptions requests (#10307)
getNodeAjaxOptions() in web/pgadmin/browser/static/js/node_ajax.js, the
shared helper behind every AJAX-backed dropdown, cached responses only
once they had resolved, so when many components asked for the same URL
before the first response landed each of them saw an empty cache and
fired its own identical GET. Every column row's Data Type dropdown
mounting at once on a wide table's Columns tab therefore produced one
get_types request per row: around 150 concurrent duplicates on a
150-column table.

Concurrent GETs are now shared in the Axios wrapper. A module-level Map
tracks requests in flight, keyed on the request axios will actually make:
api.getUri() resolves the URI exactly as the request will, honouring the
instance baseURL, plain-object params, URLSearchParams and any custom
paramsSerializer, whilst the instance's own header configuration and the
per-request headers are hashed in alongside it, so an instance built with
extra headers never shares with a plain one. Params are canonicalised
first so that callers passing the same values in a different order still
share. The entry is removed once the request settles, success or failure,
so nothing leaks and later callers fetch fresh data.

Beyond params and headers there is plenty in an axios config that cannot
be captured in a key and that changes either what a caller gets back or
how it can be aborted: transformResponse, responseType, validateStatus,
timeout, signal and so on. Rather than let those share silently, a
request carrying anything outside the shareable set goes straight through
to api.get().

Each caller still runs its own caching and transform on the shared
response, so cached behaviour and response-shape handling are unchanged.

Fixes #10155.
2026-08-18 10:02:30 +01:00
Dave Page 81ac80321e fix: make the auth gating test independent of import order
The test added in #10240 fails in a full run, though it passes when the
authenticate package is tested on its own:

    FAIL: runTest (pgadmin.authenticate.tests.test_auth_gating
                   .AuthSourceGatingTestCase)
    AssertionError: 'oauth2' not found in
                    ['internal', 'kerberos', 'ldap', 'webserver']

It cleared sys.modules for each provider and expected load_modules(), which
reaches them with "from . import <provider>", to import and hence re-register
them. That is not enough: IMPORT_FROM finds the attribute already set on the
parent package by whichever earlier test imported the module, and returns the
previous module object without re-executing it, so the provider never
re-registers itself.

Only oauth2 was affected, because it is the one provider imported earlier in a
full run, by the tests under browser/tests. Nothing pre-imports it when the
authenticate package is run alone, which is why the narrow run passed and CI
did not.

Drop the attribute from the parent package alongside the sys.modules entry, so
the import genuinely happens again.

Verified with the full suite as CI runs it, python regression/runtests.py
--exclude feature_tests: both scenarios pass and the runner's own exit status
is clean, with the only remaining failure a local config-directory permissions
check that depends on the developer's config_local.py.
2026-08-17 16:54:47 +01:00
agu2347 01e5bf0993 Schema Diff: fix false SERIAL/BIGSERIAL differences and invalid ALTER SQL (#10248)
Schema Diff compares tables whose serial columns have been
reverse-engineered back onto the SERIAL/BIGSERIAL/SMALLSERIAL pseudo-type,
and that reprojection left two problems behind for any column declared as
SERIAL.

First, the raw oid of the sequence behind the column's nextval() default
(defseqrelid) was still being compared, and two independently created
databases assign that sequence completely different oids, so structurally
identical columns were reported as different; it is now ignored alongside
its sibling seqrelid.

Second, the SQL generated for a serial column that genuinely does differ
read the column's old properties straight from the catalogue without the
same reprojection, so the real integer type and the real nextval() default
were compared against the pseudo-type and its emptied default. Any genuine
difference, such as a comment or a NOT NULL, therefore also rendered an
invalid ALTER COLUMN ... TYPE bigserial, a spurious DROP DEFAULT, and a set
of sequence options that only an identity column accepts. The changed
column is now normalised back onto the type that ALTER COLUMN can actually
be given, whilst the sequence it owns is left to the sequence object's own
comparison.

Covered by a unit test for the column comparison and by a Schema Diff test
that applies the generated SQL to the target and re-compares.

Fixes #10236
2026-08-17 14:58:21 +01:00
byshy 549d71a203 feat: toggle Object Explorer by re-clicking Default workspace icon (#10254)
Clicking the Default workspace icon whilst that workspace is already
current now collapses the Object Explorer, and clicking it again brings it
back, in the manner of the VS Code side bar. The choice is remembered in a
new Browser/ObjectExplorerVisible setting, so it survives a refresh, and
File → Reset Layout restores the panel along with the rest of the layout.

The panel is hidden with CSS rather than unmounted, so the tree keeps its
expansion and selection state whilst it is out of the way, and because
rc-dock sizes box children with flex, the main panel takes the freed width
with no gap left behind.

Folded in during review:

The Object Explorer keyboard shortcut no longer does nothing when the
sidebar is collapsed. It asks for the panel to be shown first, through a
pgadmin:object-explorer:show event on pgAdmin.Browser.Events. The focus()
call in bindLeftTree() was already inert, since the panel is a div with no
tabindex, so the useful part of that shortcut is the tree selection that
follows it.

LayoutDocker now fires a RESET event which BrowserComponent listens for,
rather than resetLayout() being monkey-patched onto the shared docker
instance. That removes a mutation of an object other code holds a
reference to.

A failed attempt to persist the setting is logged rather than silently
discarded, since otherwise the sidebar could disagree with the server after
the next refresh with nothing to explain why.

The icon's tooltip says Show or Hide Object Explorer while it acts as a
toggle, instead of describing a workspace switch that will not happen, and
aria-pressed exposes the state to assistive technology.

Tests in web/regression/javascript/workspaces/WorkspaceProvider.spec.jsx
cover the default, the saved setting being honoured, each toggle persisting
its new value, two toggles in one tick resolving in order, and the reveal
event.
2026-08-17 14:49:49 +01:00
dependabot[bot] 7b592f2e82 Javascript dependency: Bump image-minimizer-webpack-plugin in /web (#10288)
Bumps [image-minimizer-webpack-plugin](https://github.com/webpack/image-minimizer-webpack-plugin) from 4.1.4 to 5.0.0.
- [Release notes](https://github.com/webpack/image-minimizer-webpack-plugin/releases)
- [Changelog](https://github.com/webpack/image-minimizer-webpack-plugin/blob/main/CHANGELOG.md)
- [Commits](https://github.com/webpack/image-minimizer-webpack-plugin/compare/v4.1.4...v5.0.0)

---
updated-dependencies:
- dependency-name: image-minimizer-webpack-plugin
  dependency-version: 5.0.0
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-17 14:48:25 +01:00
Dave Page efc0dea335 docs: describe what AI features transmit to LLM providers (#10291)
The AI documentation covered how to configure each provider but said
nothing about what actually leaves the server once one is configured,
which is the first question anyone working under data residency or
procurement constraints will ask.

This adds a provider-neutral section to the AI Reports documentation
setting out what may be transmitted, which is schema definitions,
configuration settings read from pg_settings, query text, EXPLAIN plan
output and, because the Query Tool assistant can run read-only queries,
row data where the assistant judges it necessary; when nothing is
transmitted at all, which is the default, since no provider is
configured out of the box; and the fact that each provider processes
that data under its own terms and in locations of its own choosing, so
the reader knows to check both those terms and their own organisation's
policies before enabling a cloud provider.

It also makes explicit that the list of providers reflects the APIs
pgAdmin can speak to rather than a recommendation, and cross-references
the new section from the AI Assistant notes in the Query Tool
documentation.
2026-08-17 14:25:47 +01:00
dev-hari-prasad 2de30f25c0 Gate external auth providers behind SERVER_MODE in desktop mode (#10240)
Desktop mode has no use for the kerberos, ldap, mfa, oauth2 or webserver
authentication providers: AUTHENTICATION_SOURCES defaults to internal, MFA is
inert because mfa_enabled() requires SERVER_MODE, and get_logout_url() already
guards its kerberos and oauth2 branches on SERVER_MODE. So skip importing and
initialising them unless SERVER_MODE is set, leaving desktop mode with
internal authentication alone.

The accompanying test needed wiring into our own runner before it would ever
execute: web/pgadmin/authenticate/tests/ had no __init__.py, so pkgutil did
not report it and find_modules() never reached the module, and the test class
derived from unittest.TestCase rather than BaseTestGenerator, so the
TestsGeneratorRegistry metaclass never registered it and get_suite() could not
pick it up. Both are fixed here, and the two scenarios now run and pass under
regression/runtests.py.

The test no longer asserts that pgadmin.authenticate.mfa is absent from
sys.modules in desktop mode, because it is not: both pgadmin/browser/__init__
and pgadmin/user_login_check import pgadmin.authenticate.mfa.utils
unconditionally. The original assertion only held because the test itself
popped the module first.
2026-08-17 13:39:59 +01:00
Dave Page c2398d5b08 chore: stop Dependabot re-proposing pickr 1.10 and Babel 8 (#10286)
Two exclusions, both for bumps we have already established we cannot take.

pickr 1.10 switched to a dual CJS/ESM build whose CommonJS entry point exports
a namespace object rather than the class, so Babel's interop leaves
_pickr.default as an object and every dialog carrying a colour field dies on
mount. That took master's feature tests down for three days (#10264, reverted
in #10278). Because 1.9 -> 1.10 is a minor bump it rejoined the grouped
minor-and-patch PR immediately afterwards, buried among twenty other packages,
so minor updates are excluded here as well as majors until withColorPicker.js
is adapted to the new export shape.

Babel 8 requires Node ^22.18.0 || >=24.11.0, whilst Node 20 remains our
minimum, and every 8.x package peer-depends on @babel/core ^8.0.0 whilst we
are on 7.x. Taking any of them individually, as Dependabot proposed for
preset-env, eslint-parser and plugin-syntax-jsx, leaves an unsatisfiable peer
requirement and a mixed 7/8 tree. Babel 8 needs a coordinated migration across
all ten @babel/* packages once we are on Node 22.
2026-08-17 12:13:56 +01:00
dependabot[bot] 98fda1cbb0 Javascript dependency: Bump the runtime-javascript-minor-and-patch group across 1 directory with 2 updates (#10279)
Bumps the runtime-javascript-minor-and-patch group with 2 updates in the /runtime directory: [electron](https://github.com/electron/electron) and [globals](https://github.com/sindresorhus/globals).


Updates `electron` from 43.3.0 to 43.4.0
- [Release notes](https://github.com/electron/electron/releases)
- [Commits](https://github.com/electron/electron/compare/v43.3.0...v43.4.0)

Updates `globals` from 17.9.0 to 17.11.0
- [Release notes](https://github.com/sindresorhus/globals/releases)
- [Commits](https://github.com/sindresorhus/globals/compare/v17.9.0...v17.11.0)

---
updated-dependencies:
- dependency-name: electron
  dependency-version: 43.4.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: runtime-javascript-minor-and-patch
- dependency-name: globals
  dependency-version: 17.11.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: runtime-javascript-minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-17 12:08:25 +01:00
Dave Page c20f0e33bb chore: stop Dependabot proposing major jest-dom bumps (#10280)
@testing-library/jest-dom 7 declares "engines": {"node": ">=22"}, whilst Node
20 remains our minimum and is what most of the buildfarm runs. The bump passes
our JS tests on Node 20 in practice, so this is a deliberate choice not to
depend on an officially unsupported combination rather than a reaction to a
failure.

The "^6.9.1" constraint in web/package.json already prevents 7.x from being
installed; what Dependabot proposes is widening that constraint, which is the
part we do not want, so ignore major updates for this package until the
buildfarm moves to Node 22. See #10271 and #10210.
2026-08-17 10:35:22 +01:00
dependabot[bot] e2ca7bb447 Javascript dependency: Bump @tanstack/react-virtual in /web (#10270)
Bumps [@tanstack/react-virtual](https://github.com/TanStack/virtual/tree/HEAD/packages/react-virtual) from 3.13.24 to 3.14.9.
- [Release notes](https://github.com/TanStack/virtual/releases)
- [Changelog](https://github.com/TanStack/virtual/blob/main/packages/react-virtual/CHANGELOG.md)
- [Commits](https://github.com/TanStack/virtual/commits/@tanstack/react-virtual@3.14.9/packages/react-virtual)

---
updated-dependencies:
- dependency-name: "@tanstack/react-virtual"
  dependency-version: 3.14.9
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-17 10:29:57 +01:00
dependabot[bot] e3626c4918 Python dependency: Bump selenium in /web/regression (#10267)
Bumps [selenium](https://github.com/SeleniumHQ/Selenium) from 4.46.0 to 4.47.0.
- [Release notes](https://github.com/SeleniumHQ/Selenium/releases)
- [Commits](https://github.com/SeleniumHQ/Selenium/compare/selenium-4.46.0...selenium-4.47.0)

---
updated-dependencies:
- dependency-name: selenium
  dependency-version: 4.47.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-17 10:29:46 +01:00
Dave Page 7790264acb chore: batch minor and patch Dependabot updates into one PR per manifest (#10277)
We were carrying 27 open Dependabot PRs, the great majority of them single
patch bumps of transitive packages, and the review cost of that queue is
entirely out of proportion to its risk. Every genuine problem found whilst
clearing it (paramiko 5.0 breaking sshtunnel, use-resize-observer 10.0 dropping
its default export, jest-dom 7.0 requiring a newer Node) was a major bump.

Group minor and patch updates into a single weekly PR per manifest, and leave
major updates arriving individually so each still gets its own review. Grouping
applies to version updates only, so security updates are unaffected and
continue to arrive as separate PRs.
2026-08-17 10:23:20 +01:00
Dave Page 8ceffe310b Revert "Javascript dependency: Bump @simonwep/pickr from 1.9.1 to 1.10.1 in /web (#10264)" (#10278)
This reverts commit 34dba5740e0e0e3bb6dd06afe4d84f9e4c0a9a6e.

pickr 1.10.1 breaks every dialog carrying a colour field, which includes
Register - Server, so the dialog renders as "Something went wrong." and all
feature tests time out waiting for its fields.

The cause is a dual-package interop change rather than anything in our code.
In 1.9.1 the UMD factory ended with "return e = e.default", so module.exports
was the Pickr class itself; Babel's _interopRequireDefault saw no __esModule
marker, wrapped it, and _pickr.default was the constructor. In 1.10.1 the
factory instead returns a namespace object carrying a default getter, still
without an __esModule marker, so the wrapper nests it one level deeper and
_pickr.default is that namespace object:

  TypeError: _pickr.default is not a constructor
      at initPickr (pgadmin/static/js/helpers/withColorPicker.js:69)

Nothing in the JS unit tests, eslint or the webpack build can see this,
because it only fails when the component mounts, which is why the bump went in
with a green board and only the feature tests caught it.

Moving to 1.10.1 later is perfectly possible, but it needs the import in
withColorPicker.js adapted to the new shape, and it must be validated by
opening a dialog rather than by a green Jest run.
2026-08-17 10:22:50 +01:00
dependabot[bot] 34dba57409 Javascript dependency: Bump @simonwep/pickr from 1.9.1 to 1.10.1 in /web (#10264)
Bumps [@simonwep/pickr](https://github.com/simonwep/pickr) from 1.9.1 to 1.10.1.
- [Release notes](https://github.com/simonwep/pickr/releases)
- [Commits](https://github.com/simonwep/pickr/compare/1.9.1...v1.10.1)

---
updated-dependencies:
- dependency-name: "@simonwep/pickr"
  dependency-version: 1.10.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 13:12:02 +01:00
dependabot[bot] 6fac4f0cbe Javascript dependency: Bump eslint from 10.8.0 to 10.8.1 in /runtime (#10260)
Bumps [eslint](https://github.com/eslint/eslint) from 10.8.0 to 10.8.1.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Commits](https://github.com/eslint/eslint/compare/v10.8.0...v10.8.1)

---
updated-dependencies:
- dependency-name: eslint
  dependency-version: 10.8.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 13:08:56 +01:00
dependabot[bot] 12830a7be8 Python dependency: Update setuptools requirement from ==83.* to ==84.* (#10261)
Updates the requirements on [setuptools](https://github.com/pypa/setuptools) to permit the latest version.
- [Release notes](https://github.com/pypa/setuptools/releases)
- [Changelog](https://github.com/pypa/setuptools/blob/main/NEWS.rst)
- [Commits](https://github.com/pypa/setuptools/compare/v83.0.0...v84.0.0)

---
updated-dependencies:
- dependency-name: setuptools
  dependency-version: 84.0.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 13:08:31 +01:00
dependabot[bot] 1b48d616f9 Javascript dependency: Bump @testing-library/user-event in /web (#10262)
Bumps [@testing-library/user-event](https://github.com/testing-library/user-event) from 14.6.1 to 14.6.3.
- [Release notes](https://github.com/testing-library/user-event/releases)
- [Changelog](https://github.com/testing-library/user-event/blob/main/CHANGELOG.md)
- [Commits](https://github.com/testing-library/user-event/compare/v14.6.1...v14.6.3)

---
updated-dependencies:
- dependency-name: "@testing-library/user-event"
  dependency-version: 14.6.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 13:08:22 +01:00
dependabot[bot] 39a56a1074 Python dependency: Update cryptography requirement (#10263)
Updates the requirements on [cryptography](https://github.com/pyca/cryptography) to permit the latest version.
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pyca/cryptography/compare/49.0.0...50.0.0)

---
updated-dependencies:
- dependency-name: cryptography
  dependency-version: 50.0.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 13:08:19 +01:00
dependabot[bot] 6de909b2d5 Javascript dependency: Bump globals from 17.8.0 to 17.9.0 in /runtime (#10259)
Bumps [globals](https://github.com/sindresorhus/globals) from 17.8.0 to 17.9.0.
- [Release notes](https://github.com/sindresorhus/globals/releases)
- [Commits](https://github.com/sindresorhus/globals/compare/v17.8.0...v17.9.0)

---
updated-dependencies:
- dependency-name: globals
  dependency-version: 17.9.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 12:04:02 +01:00
dependabot[bot] 1908d468f1 Javascript dependency: Bump electron from 43.2.0 to 43.3.0 in /runtime (#10258)
Bumps [electron](https://github.com/electron/electron) from 43.2.0 to 43.3.0.
- [Release notes](https://github.com/electron/electron/releases)
- [Commits](https://github.com/electron/electron/compare/v43.2.0...v43.3.0)

---
updated-dependencies:
- dependency-name: electron
  dependency-version: 43.3.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 12:03:59 +01:00
Flipper 9cd0e35f47 Add backendRefs group and kind to httproute.yaml (#10222) 2026-08-14 11:34:31 +01:00
Martin Manka 3cb33475ec Helm Chart: Add existingClaim to persistence (#10230) 2026-08-14 11:33:39 +01:00
byshyandCursor e6e35bb4c4 fix(pkg): remove trailing quote from Windows ProductVersion (#10250)
rcedit was passed "%APP_VERSION%"", which stamped ProductVersion as
e.g. 9.17" on Windows installer builds.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-14 11:31:43 +01:00
dependabot[bot] 1dd4d00246 Javascript dependency: Bump ip-address from 10.2.0 to 10.3.1 in /web (#10225)
Bumps [ip-address](https://github.com/beaugunderson/ip-address) from 10.2.0 to 10.3.1.
- [Release notes](https://github.com/beaugunderson/ip-address/releases)
- [Commits](https://github.com/beaugunderson/ip-address/compare/v10.2.0...v10.3.1)

---
updated-dependencies:
- dependency-name: ip-address
  dependency-version: 10.3.1
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:27:59 +01:00
Dave Page 9338129183 chore: stop Dependabot proposing major paramiko bumps (#10257)
paramiko 5.0 removed DSSKey entirely, whilst sshtunnel 0.4.0 still refers to
paramiko.DSSKey in SSHTunnelForwarder.get_keys(), which _consolidate_auth()
calls from the constructor. A major bump therefore does not merely drop DSA
key support, it raises AttributeError before any SSH tunnelled connection can
be established, and nothing in CI covers SSH tunnels so it looks green.
sshtunnel has had no release since 0.4.0 in 2019, so there is nothing newer to
move to on that side.

Ignore major paramiko updates until sshtunnel is fixed or replaced. The
exclusion is repeated under the /web/regression entry because
web/regression/requirements.txt starts with "-r ../../requirements.txt", so
that entry sees the root pins too.
2026-08-14 11:26:51 +01:00
dependabot[bot] 2d989238a4 Javascript dependency: Bump tar from 7.5.16 to 7.5.21 in /web (#10182)
Bumps [tar](https://github.com/isaacs/node-tar) from 7.5.16 to 7.5.21.
- [Release notes](https://github.com/isaacs/node-tar/releases)
- [Changelog](https://github.com/isaacs/node-tar/blob/main/CHANGELOG.md)
- [Commits](https://github.com/isaacs/node-tar/compare/v7.5.16...v7.5.21)

---
updated-dependencies:
- dependency-name: tar
  dependency-version: 7.5.21
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:21:06 +01:00
dependabot[bot] aa16a12182 Javascript dependency: Bump shell-quote from 1.8.4 to 1.10.0 in /web (#10185)
Bumps [shell-quote](https://github.com/ljharb/shell-quote) from 1.8.4 to 1.10.0.
- [Changelog](https://github.com/ljharb/shell-quote/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ljharb/shell-quote/compare/v1.8.4...v1.10.0)

---
updated-dependencies:
- dependency-name: shell-quote
  dependency-version: 1.10.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:21:03 +01:00
dependabot[bot] d9635cd2cd Javascript dependency: Bump svgo-loader from 4.0.0 to 5.0.0 in /web (#10207)
Bumps [svgo-loader](https://github.com/svg/svgo-loader) from 4.0.0 to 5.0.0.
- [Release notes](https://github.com/svg/svgo-loader/releases)
- [Commits](https://github.com/svg/svgo-loader/compare/v4.0.0...v5.0.0)

---
updated-dependencies:
- dependency-name: svgo-loader
  dependency-version: 5.0.0
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:21:00 +01:00
dependabot[bot] 904bb2e1e2 Javascript dependency: Bump anti-trojan-source in /web (#10211)
Bumps [anti-trojan-source](https://github.com/lirantal/anti-trojan-source) from 1.12.0 to 1.12.1.
- [Release notes](https://github.com/lirantal/anti-trojan-source/releases)
- [Changelog](https://github.com/lirantal/anti-trojan-source/blob/main/RELEASE.md)
- [Commits](https://github.com/lirantal/anti-trojan-source/compare/v1.12.0...v1.12.1)

---
updated-dependencies:
- dependency-name: anti-trojan-source
  dependency-version: 1.12.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:56 +01:00
dependabot[bot] 02c8b3748e Javascript dependency: Bump brace-expansion in /web (#10220)
Bumps [brace-expansion](https://github.com/juliangruber/brace-expansion) from 1.1.16 to 1.1.18.
- [Release notes](https://github.com/juliangruber/brace-expansion/releases)
- [Commits](https://github.com/juliangruber/brace-expansion/commits)

---
updated-dependencies:
- dependency-name: brace-expansion
  dependency-version: 1.1.18
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:53 +01:00
dependabot[bot] 6696db11be Javascript dependency: Bump socket.io-parser from 4.2.6 to 4.2.7 in /web (#10229)
Bumps [socket.io-parser](https://github.com/socketio/socket.io) from 4.2.6 to 4.2.7.
- [Release notes](https://github.com/socketio/socket.io/releases)
- [Changelog](https://github.com/socketio/socket.io/blob/main/CHANGELOG.md)
- [Commits](https://github.com/socketio/socket.io/compare/socket.io-parser@4.2.6...socket.io-parser@4.2.7)

---
updated-dependencies:
- dependency-name: socket.io-parser
  dependency-version: 4.2.7
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:50 +01:00
dependabot[bot] 109706d8f8 Javascript dependency: Bump fast-uri from 3.1.4 to 3.1.5 in /web (#10232)
Bumps [fast-uri](https://github.com/fastify/fast-uri) from 3.1.4 to 3.1.5.
- [Release notes](https://github.com/fastify/fast-uri/releases)
- [Commits](https://github.com/fastify/fast-uri/compare/v3.1.4...v3.1.5)

---
updated-dependencies:
- dependency-name: fast-uri
  dependency-version: 3.1.5
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:47 +01:00
dependabot[bot] 8cc69cf71c Javascript dependency: Bump dompurify from 3.4.12 to 3.4.13 in /web (#10241)
Bumps [dompurify](https://github.com/cure53/DOMPurify) from 3.4.12 to 3.4.13.
- [Release notes](https://github.com/cure53/DOMPurify/releases)
- [Commits](https://github.com/cure53/DOMPurify/compare/3.4.12...3.4.13)

---
updated-dependencies:
- dependency-name: dompurify
  dependency-version: 3.4.13
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:43 +01:00
dependabot[bot] 1a87ee14d9 Javascript dependency: Bump js-yaml from 3.15.0 to 3.15.1 in /web (#10244)
Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.15.0 to 3.15.1.
- [Changelog](https://github.com/nodeca/js-yaml/blob/3.15.1/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/3.15.0...3.15.1)

---
updated-dependencies:
- dependency-name: js-yaml
  dependency-version: 3.15.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:39 +01:00
dependabot[bot] 73c5e01309 Javascript dependency: Bump postcss from 8.5.21 to 8.5.23 in /web (#10246)
Bumps [postcss](https://github.com/postcss/postcss) from 8.5.21 to 8.5.23.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss/compare/8.5.21...8.5.23)

---
updated-dependencies:
- dependency-name: postcss
  dependency-version: 8.5.23
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:35 +01:00
dependabot[bot] 1cca96b62c Javascript dependency: Bump eslint from 10.7.0 to 10.8.0 in /runtime (#10204)
Bumps [eslint](https://github.com/eslint/eslint) from 10.7.0 to 10.8.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Commits](https://github.com/eslint/eslint/compare/v10.7.0...v10.8.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-version: 10.8.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:31 +01:00
dependabot[bot] 74687c9ddf Javascript dependency: Bump brace-expansion in /runtime (#10219)
Bumps [brace-expansion](https://github.com/juliangruber/brace-expansion) from 5.0.7 to 5.0.9.
- [Release notes](https://github.com/juliangruber/brace-expansion/releases)
- [Commits](https://github.com/juliangruber/brace-expansion/compare/v5.0.7...v5.0.9)

---
updated-dependencies:
- dependency-name: brace-expansion
  dependency-version: 5.0.9
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:28 +01:00
dependabot[bot] 0d6973c042 Javascript dependency: Bump globals from 17.7.0 to 17.8.0 in /runtime (#10223)
Bumps [globals](https://github.com/sindresorhus/globals) from 17.7.0 to 17.8.0.
- [Release notes](https://github.com/sindresorhus/globals/releases)
- [Commits](https://github.com/sindresorhus/globals/compare/v17.7.0...v17.8.0)

---
updated-dependencies:
- dependency-name: globals
  dependency-version: 17.8.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:25 +01:00
dependabot[bot] 0b9fb6fc06 Javascript dependency: Bump axios from 1.18.1 to 1.19.0 in /runtime (#10224)
Bumps [axios](https://github.com/axios/axios) from 1.18.1 to 1.19.0.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v1.18.1...v1.19.0)

---
updated-dependencies:
- dependency-name: axios
  dependency-version: 1.19.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:21 +01:00
dependabot[bot] 60d4dd8c5a Javascript dependency: Bump undici from 7.28.0 to 7.29.0 in /runtime (#10227)
Bumps [undici](https://github.com/nodejs/undici) from 7.28.0 to 7.29.0.
- [Release notes](https://github.com/nodejs/undici/releases)
- [Commits](https://github.com/nodejs/undici/compare/v7.28.0...v7.29.0)

---
updated-dependencies:
- dependency-name: undici
  dependency-version: 7.29.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:18 +01:00
dependabot[bot] df7c256b53 Javascript dependency: Bump fast-uri from 3.1.4 to 3.1.5 in /runtime (#10231)
Bumps [fast-uri](https://github.com/fastify/fast-uri) from 3.1.4 to 3.1.5.
- [Release notes](https://github.com/fastify/fast-uri/releases)
- [Commits](https://github.com/fastify/fast-uri/compare/v3.1.4...v3.1.5)

---
updated-dependencies:
- dependency-name: fast-uri
  dependency-version: 3.1.5
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:12 +01:00
dependabot[bot] db7cbc7900 Python dependency: Update typer requirement from ==0.26.* to ==0.27.* (#10203)
Updates the requirements on [typer](https://github.com/fastapi/typer) to permit the latest version.
- [Release notes](https://github.com/fastapi/typer/releases)
- [Changelog](https://github.com/fastapi/typer/blob/master/docs/release-notes.md)
- [Commits](https://github.com/fastapi/typer/compare/0.26.0...0.27.0)

---
updated-dependencies:
- dependency-name: typer
  dependency-version: 0.27.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:08 +01:00
dependabot[bot] aac7d33441 Python dependency: Bump certifi from 2026.6.17 to 2026.7.22 (#10205)
Bumps [certifi](https://github.com/certifi/python-certifi) from 2026.6.17 to 2026.7.22.
- [Commits](https://github.com/certifi/python-certifi/compare/2026.06.17...2026.07.22)

---
updated-dependencies:
- dependency-name: certifi
  dependency-version: 2026.7.22
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:05 +01:00
dependabot[bot] 9e0a847410 Python dependency: Bump selenium in /web/regression (#10206)
Bumps [selenium](https://github.com/SeleniumHQ/Selenium) from 4.45.0 to 4.46.0.
- [Release notes](https://github.com/SeleniumHQ/Selenium/releases)
- [Commits](https://github.com/SeleniumHQ/Selenium/compare/selenium-4.45.0...selenium-4.46.0)

---
updated-dependencies:
- dependency-name: selenium
  dependency-version: 4.46.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-08-14 11:20:02 +01:00
Dave Page 35d68c47eb fix: follow Flask-Security-Too 5.8.2's corrected is_locked() semantics (#10256)
Flask-Security-Too 5.8.2, released on 12 August 2026, fixed a long-standing
inversion in its login forms: `LoginForm.validate()` previously read a `True`
return from `UserMixin.is_locked()` as "not locked, carry on", and the base
implementation unconditionally returned `True`. Our `User.is_locked()` was
written against that inverted convention, so as soon as CI began resolving
5.8.2 through the loose `Flask-Security-Too==5.8.*` pin, an unlocked user
returned `True`, form validation failed, the login POST redirected with a 302
and every subsequent request arrived as `AnonymousUser`. The server-mode data
isolation tests caught it, though the breakage is not limited to tests: on
5.8.2 nobody could log in at all.

`User.is_locked()` now returns `True` when the account is locked, matching the
corrected upstream contract, and the dependency is floored at 5.8.2 so that we
cannot silently resolve a release which reads the value backwards. The two
conventions are mutually exclusive, hence a floor rather than a version check
in the model. The regression tests are updated to assert the fixed contract.
2026-08-14 11:17:09 +01:00
Dave Page 6487f2a93f Add support for Python 3.14 (#10255)
Python 3.14 is now supported, so add the trove classifier for it to the
pip packaging metadata and move the desktop builds onto it: the macOS
bundle now defaults to 3.14.7, and the Windows build looks for an
interpreter in C:\Python314 by default, with both build READMEs updated
to match. The minimum supported version is unchanged at 3.9.

Whilst here, the SonarQube scanner's Python compatibility list had drifted
somewhat, still naming 3.7 and 3.8 and stopping at 3.11, so it has been
brought into line with the versions we actually support.
2026-08-14 11:16:25 +01:00
Ashesh Vashi 067f7af227 revert(pkg): back out all _fixup_imports path-handling attempts
pkg/mac/build-functions.sh reverted to bd841b882's state - keeps the
notarization diagnostic fix (print REQUEST_STATUS + fetch notarytool
log on failure), drops everything from 0296de48e through 6891b5e12.

Five iterations trying to fix _fixup_imports's otool handling of
"pgAdmin 4 Helper (GPU)" (newline-based path list, otool-classic
fallback via bare name, via resolved absolute path, absolute-path
retries for otool/install_name_tool) all failed to get the appbundle
build past this file. Confirmed along the way: the path itself is
byte-for-byte correct and the file verifiably exists at the moment
otool runs (od -c / ls -la evidence from a live buildfarm run); both
otool and otool-classic, called directly with correct quoting and a
resolved absolute path, still fail identically on it. That's a real
bug/limitation in Apple's tooling on this build node, not fixable by
further changes to how this script constructs or passes the path.

Reverting rather than continuing to guess. The stale nspkg.pth /
--system-site-packages fix in pkg/linux/build-functions.sh (verified
working, pgadmin4-rpm-build #180 succeeded) is untouched by this.
2026-07-30 12:30:49 +05:30
Ashesh Vashi 6891b5e12f fix(pkg): retry otool/install_name_tool with absolute path before giving up
pgadmin4-appbundle-build #116 (macos-arm64) failed even with
otool-classic invoked directly via its real resolved path
(669c2f244's fix) - identical error, byte-for-byte, to calling plain
`otool -L`:

  can't open file: .../pgAdmin 4 Helper  (No such file or directory)

That rules out PATH resolution and otool's internal re-exec dispatch
as the cause too. Both otool -L and otool-classic -L, invoked directly
with correct argv quoting and a verified-correct, verified-present
path, fail identically on this one binary. Whatever's actually broken
is inside these tools' own handling of "(" in a path they're given.

Untested variable so far: this script pushd's into the bundle dir and
passes relative paths ("./Contents/...") throughout. Try a plain
absolute path with each tool before falling back to the diagnostic
dump - cheap to test, and applies equally to the two
`install_name_tool -change` calls further down that edit this same
file in place, since they could hit the identical issue.

Still not proven - if this also fails, the diagnostic dump (retained
as final fallback) will at least confirm parens themselves are the
blocker regardless of path form, which would mean sidestepping via a
temporary parens-free symlink is the next thing to try.
2026-07-30 12:10:59 +05:30
Ashesh Vashi 669c2f2442 fix(pkg): resolve otool-classic's real path, bare name isn't on PATH
pgadmin4-appbundle-build #115 (macos-arm64) failed even with the
otool-classic fallback from 2d17e9e15:

  otool-classic output: .../build-functions.sh: line 260:
    otool-classic: command not found

otool-classic only exists inside the active Xcode toolchain
(/Applications/Xcode.app/.../XcodeDefault.xctoolchain/usr/bin/
otool-classic - the exact path visible in otool's own internal error
message), not as a bare command on $PATH. The previous fallback never
actually tested whether the real otool-classic binary can open the
file - it just failed on a missing command.

Resolve the real path via `xcrun -f otool-classic` (falling back to
deriving it from `xcode-select -p` if xcrun's lookup is unavailable)
and invoke that directly.

Not yet verified against a real buildfarm run.
2026-07-30 12:01:52 +05:30
Ashesh Vashi 2d17e9e15d fix(pkg): retry via otool-classic directly, now with hard evidence
pgadmin4-appbundle-build #114 (macos-arm64) failed on the same
"pgAdmin 4 Helper (GPU)" binary as before, but this time the
diagnostics from d4364555a actually ran and proved the path itself is
not the problem:

  Raw bytes of the path (od -c): plain ASCII throughout, single
  spaces, no non-breaking/unicode look-alikes, no trailing garbage.
  ls -la of the exact path: file exists, correct size/perms,
  timestamped seconds before otool ran - not a race condition either.

otool -L still failed via its internal otool-classic re-exec on that
exact, verified-correct, verified-present file. That's conclusively a
bug in otool's own internal dispatch, not anything this script builds
or passes to it - we can't fix Apple's tool, but we can avoid
triggering its broken code path.

Retry via `otool-classic -L "${TODO_OBJ}"` called directly (our own
argv-based quoting, not otool's internal re-exec, whatever that does
differently) when the initial `otool -L` fails. Every other binary in
the bundle keeps going through plain `otool -L` unchanged - this only
engages for the specific case that's already failing anyway. The
diagnostic dump (od -c / ls -la / otool-classic's own output) is kept
as the final fallback in case even the direct call fails too.

Not yet verified against a real buildfarm run.
2026-07-30 11:55:29 +05:30
Ashesh Vashi d4364555ae fix(pkg): diagnostics never ran - set -e ate the failure before $? check
pgadmin4-appbundle-build #113 (macos-arm64) failed again on the same
otool -L call, but none of the diagnostic output from 401afbfa3 showed
up. Instead:

  The command "OTOOL_OUTPUT=$(otool -L "${TODO_OBJ}" 2>&1)" failed in
  "_fixup_imports" with exit code 1.

That's this script's own ERR trap firing on the assignment statement
itself. Under set -e, `VAR=$(cmd)` still propagates cmd's non-zero
exit to the trap immediately - the previous diagnostic's separate
`OTOOL_STATUS=$?` line right after never got a chance to run, so
nothing was ever printed, same as the original bare failure.

Move the assignment into the condition of the `if` itself
(`if ! OTOOL_OUTPUT=$(...); then`) - bash explicitly exempts a
command being tested by if/while/until (or negated with !) from
errexit, so this time the diagnostic block will actually execute.

Still not verified - watching the next buildfarm run.
2026-07-30 11:28:36 +05:30
Ashesh Vashi 401afbfa31 fix(pkg): add diagnostics for otool -L failures instead of guessing
pgadmin4-appbundle-build #112 (macos-arm64) failed with otool-classic
unable to open a path that our own logging showed as correct
immediately beforehand ("pgAdmin 4 Helper (GPU)"). Rather than work
around it blindly (an otool-classic fallback was tried and reverted -
unverified, and risks masking a real problem instead of fixing it),
capture real evidence the next time this happens:

- raw byte dump (od -c) of ${TODO_OBJ} right before otool runs, and
  again on failure - catches non-ASCII or invisible whitespace that
  a plain `echo` can't show
- ls -la of the exact path and its containing directory on failure -
  confirms whether the file actually exists at that exact moment
  (rules out/in a race with something still writing it)
- otool's actual stdout/stderr and exit code, instead of letting its
  own error text be the only signal

No fallback behavior - fails loudly (exit 1) with this diagnostic
dump so we can tell what's actually happening from the next real
buildfarm run instead of speculating further.
2026-07-30 11:20:38 +05:30
Ashesh Vashi 0296de48ee fix(pkg): _fixup_imports truncates paths with spaces, breaking otool
pgadmin4-appbundle-build #110 (macos-x64) failed with:
  error: otool-classic: can't open file: ./Contents/Frameworks/pgAdmin
  error: otool-classic: can't open file: ./Contents/Frameworks/Electron

_fixup_imports built its worklist with `awk -F':| '`, a regex
alternation that splits on a literal ':' OR any bare space. `file`'s
actual output format is "path: description" (colon-space as one
token), so any space *inside* the path itself - "pgAdmin 4 Helper
(Plugin).app", "Electron Framework.framework", both routine in macOS
app bundles - also got treated as a split point, truncating $1 to
whatever preceded the first space.

The resulting list was then joined with a single space (ORS=" ") and
iterated via an unquoted `for x in $list`, which word-splits on
spaces again - doubly ambiguous between a path's own spaces and the
list's separator, unrecoverable however it's parsed.

Fix: split only on the literal ": " token file emits (`awk -F': '`,
not `-F ':| '`), and switch the whole worklist to newline-separated
instead of space-separated, iterated with `while IFS= read -r`
instead of `for x in $unquoted_list`, at both the outer (executable)
level and inner (library-copy) level (`TODO="${TODO}"$'\n'"..."`).

Not yet verified against a real buildfarm run - can't reproduce the
macOS codesigning environment locally. Watching the next
pgadmin4-appbundle-build run.
2026-07-30 09:48:03 +05:30
Ashesh Vashi 689c969f95 fix(pkg): stop using --system-site-packages, use a scoped .pth instead
The previous fix (bd841b882) tried to delete the specific broken
sphinxcontrib-jsmath nspkg.pth file from the system site-packages
before creating the venv. It didn't work: pgadmin4-rpm-build #177
failed identically on el-10. The delete silently no-opped - that
directory is root-owned on the build node and the build user doesn't
have write access there, so `find -delete` failed while `-print` (which
runs first) still logged the match, making the fix look like it ran.

Root cause is the --system-site-packages flag itself: it uses Python's
site.addsitedir() internally, which does not just add a directory to
sys.path - it also scans that directory for every *.pth file and
executes any "import ..." lines found in them. That's what runs the
broken nspkg.pth's stale namespace-package bootstrap code and corrupts
sys.path before core stdlib resolves, breaking pip's own subprocess.

We only need --system-site-packages for OS-provided packages that
don't have reliable pip wheels (e.g. dbus-python, a hard runtime
dependency per pkg/debian/build.sh's python3-dbus dep, needs
libdbus-1-dev to build from source). A *plain path line* (no "import")
in a .pth file only appends that directory to sys.path - it does not
trigger a further .pth scan of it. So: create the venv without
--system-site-packages, then write the system site-packages
directories as plain lines into a .pth file inside the venv's own
site-packages (which the build user does own). Same OS-package
availability, without ever asking Python to treat the system directory
as a site directory - the broken nspkg.pth is simply never read.

Not yet verified against a real buildfarm run - can't reproduce the
el-10 environment locally. Watching the next pgadmin4-rpm-build run.
2026-07-30 09:36:44 +05:30
Ashesh Vashi bd841b8827 fix(pkg): surface real notarization failures, guard against stale nspkg.pth in venv
macOS build (build-functions.sh): _notarize_pkg only printed
"Notarization failed." on rejection, giving no indication why. Print
the actual REQUEST_STATUS and fetch the full notary log via
`notarytool log` so future failures are actually diagnosable from the
Jenkins console instead of just "status: Invalid".

Linux build (build-functions.sh): _create_python_virtualenv creates
venvs with --system-site-packages, which pulls in the entire system
site-packages dir - including any stale, improperly-uninstalled
package's namespace-package .pth hook. That legacy pip/setuptools
mechanism runs at interpreter startup, before core stdlib is
guaranteed to resolve; a leftover sphinxcontrib-jsmath nspkg.pth on
the el-10 build node corrupted sys.path early enough to break pip's
own subprocess bootstrap, failing the whole build with a misleading
"No module named 'importlib'"/"'traceback'" error
(pgadmin4-rpm-build #176). Remove that exact known-broken file before
creating the venv - not every *-nspkg.pth, since this touches the
*system* Python install on a build node shared by other jobs, and any
other such file could still be load-bearing for something unrelated.
--system-site-packages itself is left untouched - it's required so
venvs can see OS-provided packages not available as clean pip wheels
on every target platform.
2026-07-30 09:21:22 +05:30
Ashesh Vashi 3f99454199 fix: unbound keyring probe at config-import time can hang desktop startup
evaluate_and_patch_config() called keyring.get_password() synchronously
at `import config` time to detect a selected-but-unusable OS keyring
backend. On Debian 13 (and similar headless/RDP sessions with no live
D-Bus/GNOME-Keyring session), that call - and even the keyring import
itself - can block forever, freezing the whole desktop app before it
ever starts.

Revert evaluate_config.py to the pre-9.17 synchronous check (backend
name only, no get_password call). Move the usability probe into
pgadmin.utils.keyring_probe, run from create_app() in a background
daemon thread so it never delays startup, isolated in its own process
via subprocess.Popen(sys.executable, '-c', ...) so a hang can actually
be killed - a thread-only timeout can't do this, it would leave
CPython's per-module import lock held forever and wedge any later
`import keyring` in the parent process too.

subprocess.Popen (plain fork+exec), not multiprocessing.Process, is
required here: create_app() runs at the top level of pgAdmin4.py while
it's still being imported, and multiprocessing's spawn start method
refuses to start a child before the current process finishes
bootstrapping its __main__ module. An earlier version of this fix used
multiprocessing and crashed the probe thread with RuntimeError on every
single test run, which corrupted the SQLAlchemy/sqlite session for the
rest of app init and surfaced as an unrelated-looking "attempt to write
a readonly database" error on module_preference inserts.

config.USE_OS_SECRET_STORAGE is only ever read from request handlers
requiring an authenticated session, never at import time or inside
create_app() itself, so the async resolution race is safe in practice.

Tests mock subprocess.Popen for the timeout/kill/config-fallback
orchestration (deterministic, no real 3s wait or backend dependency),
plus one test class that runs the real probe script in a real
subprocess against a fake keyring module injected via PYTHONPATH, so
the script body itself has real coverage.

Verified with the full regression suite (--exclude feature_tests) in
both desktop mode (2134 passed, 0 failed) and server mode (2251
passed, 0 failed); remaining skips are pre-existing pgAgent-dependent
job tests.
2026-07-30 00:00:33 +05:30
Ashesh Vashi 6e029ab6e5 docs: correct reporter credit for #10193/#10194 to full name
Hung Tran Quoc (GitHub handle @rampage0010) — release notes only
listed the given name.
2026-07-28 12:40:25 +05:30
Ashesh Vashi ee7109d400 Updated version for release v9.17 2026-07-28 12:08:09 +05:30
Ashesh Vashi 78f7a5f6ab test: restore app.PGADMIN_EXTERNAL_AUTH_SOURCE in auth-mocking tearDown
Each of the Kerberos/LDAP/OAuth2/webserver login-mocking test classes
sets self.app.PGADMIN_EXTERNAL_AUTH_SOURCE (the Flask app instance
attribute before_request() actually reads) in setUp, but tearDownClass
only restored app_config.PGADMIN_EXTERNAL_AUTH_SOURCE -- a different
object (the config module). Whichever of these classes ran last
(test_webserver_with_mocking, alphabetically) left the live app
attribute stuck at WEBSERVER for the rest of the suite, making
before_request() route every subsequent unauthenticated /login request
through authenticate.login()'s webserver auto-auth path instead of
rendering the login form -- surfacing as an unrelated CSRF-harvest
failure in test_close_requires_auth much later in the run.

Full server-mode regression: 2507 tests, 0 failures/errors (was 2).
2026-07-28 11:07:37 +05:30
Ashesh Vashi 689d200e9f test: fix server-mode test-harness bugs found running the full suite
get_test_user() created secondary test clients via app.test_client()
but never called setApp() on them, so any test using a second user
crashed with 'NoneType has no attribute config' the first time it
needed to fetch a CSRF token (44 errors in a full server-mode run).

TestSqlEditorCloseRequiresAuth.setUp() logs out the shared
class-level tester before asserting a CSRF token was harvested; when
that assertion failed, unittest skipped tearDown() entirely (by
design, tearDown only runs if setUp succeeds), leaving the tester
logged out for the rest of the suite and cascading into 188 unrelated
failures. Switched to addCleanup(), which always runs.

Full server-mode regression: 2507 tests, was 232 failures/errors,
now 2 (both isolated to this same test's own CSRF-harvest timing in
full-suite order, unrelated to these two fixes).
2026-07-28 10:12:18 +05:30
Ashesh Vashi 339b4f9cd3 Merge branch 'cve-9.17-rebase' into master 2026-07-28 09:12:21 +05:30
Domenico Sgarbossa 5fc319551d Updated message catalogs for v9.17 (#10212) 2026-07-28 09:00:14 +05:30
Ashesh Vashi 9ef9a7136f docs: add 9.17 release notes for CVE-2026-17346 through 17351, 17566
Adds bug-fix bullets for issues #10190-10194, #10200 (previously
assigned CVE-2026-17346..17351) and #10213 (CVE-2026-17566, the
import/export \copy backslash-escape RCE reported by Arpit Jain).
2026-07-28 08:56:41 +05:30
Ashesh Vashi 1496fabe28 fix(security): reject ambiguous backslash-escape in import/export query guard
_is_query_parens_balanced() always treated \' inside a single-quoted
string as an escaped quote, matching psql only when
standard_conforming_strings=off. Under the actual default (scs=on,
every supported PostgreSQL version), psql treats \ as a literal
character, so 'a\' closes the string right there. A crafted query
export payload like SELECT 'a\') TO PROGRAM 'cmd' x' passed the
balance check while the real ) it hid closed the wrapping \copy (...)
context in psql, exposing a live TO PROGRAM clause for RCE.

Since the correct interpretation depends on a server setting we
can't reliably know, reject any backslash inside a single-quoted
string outright instead of guessing.

Reported by Arpit Jain (arpitjain099).
2026-07-27 19:04:29 +05:30
Kundan ef76102bcd fix(llm): close lexer-differential bypass in AI Assistant read-only guard
sqlparse's string-literal lexing can disagree with PostgreSQL's: under
standard_conforming_strings = on (the default), a backslash before a
quote is an ordinary character to PostgreSQL but sqlparse treats it as
escaping the quote, so a payload like
SELECT '\';COMMIT;CREATE TABLE pwn(x int);SELECT 1 --'
passes _validate_readonly_query as a single SELECT while PostgreSQL
executes it as four statements -- the smuggled COMMIT ends the wrapping
BEGIN TRANSACTION READ ONLY and the trailing ROLLBACK is a no-op,
reintroducing the write/RCE bypass the bf47924444 fix was meant to
close (reported by Kai Aizen / SnailSploit).

Run the LLM-supplied query with prepare=True, forcing psycopg3's
extended query protocol. PostgreSQL's own Parse step -- not a
client-side approximation of it -- rejects any text containing more
than one statement, independent of how it's lexed. Threaded through
execute_2darray as an opt-in parameter (default None) so no other
caller's behavior changes. Also set SESSION CHARACTERISTICS AS
TRANSACTION READ ONLY as defense-in-depth against a smuggled COMMIT.

prepare=True alone is not sufficient: psycopg3's PrepareManager.get()
returns Prepare.NO -- checked before it even inspects the prepare
argument -- whenever the connection's prepare_threshold is None, which
is pgAdmin's per-server default ("Prepare threshold" is blank unless an
administrator sets it). On a default-configured server the extended
protocol never actually engaged, so the bypass stayed live. Force
prepare_threshold=0 on the LLM's single-use connection in
_connect_readonly() so the extended protocol -- and PostgreSQL's
single-statement Parse-step guarantee -- is unconditional on this
connection, without touching the server-wide setting or any other
session/caller.

Adds regression coverage at three levels: unit tests pinning that
prepare=True is always passed and that prepare_threshold=0 is forced
on the connection; and an end-to-end test driving the real
/sqleditor/nlq/chat/<trans_id>/stream route (LLM client mocked, real
tool-dispatch path) with the exact smuggled-COMMIT payload, confirming
the guarantee holds from the HTTP entry point down to the driver call.
2026-07-27 16:51:46 +05:30
Ashesh Vashi 2b4307f321 feat: add system-wide default for Geometry Viewer custom tile provider (#10198)
Follow-up to #10142. Geometry Viewer's custom tile provider was only
configurable per-user (Preferences), with no way for an administrator
to set an organization-wide default (e.g. an internal tile server)
that applies out of the box for every user.

config.DEFAULT_GEOMETRY_VIEWER_PROVIDER is a plain dict; the five
custom_tile_* preference defaults (url, name, crs, attribution,
max_zoom) are sourced from it instead of hardcoded literals.
Preference.get() only reads a per-user DB row if the user has
explicitly saved one, otherwise it falls back to this default --
override semantics, one active provider, no naming-conflict surface.

config_local.py/config_distro.py/PGADMIN_CONFIG_* replace this config
variable wholesale, not merged key-by-key, so a naive
DEFAULT_GEOMETRY_VIEWER_PROVIDER['name'] lookup would KeyError-crash
preference registration (and app startup) on any partial admin
override, or AttributeError on a wrong-typed value.
resolve_geometry_viewer_provider_defaults() guards against this:
falls back per-field on missing/wrong-type values, validates crs
against the 3 supported choices, validates max_zoom is a non-bool int
in [0, 25], degrading to the original hardcoded defaults instead of
crashing.

No new attacker-reachable surface: DEFAULT_GEOMETRY_VIEWER_PROVIDER is
filesystem/deployment-level admin config, same trust boundary as
DEFAULT_BINARY_PATHS/OAUTH2_CONFIG. Existing DOMPurify sanitization on
name/attribution and the http(s):// + {x}/{y}/{z} URL validation in
GeometryViewerUtils.js (from #10142) apply uniformly to config-sourced
and per-user values alike.

Adds test_geometry_viewer_provider_defaults.py (9 scenarios: fully
valid, partial override, non-dict, invalid CRS, out-of-range/non-int/
bool max_zoom, non-string fields, empty dict).
2026-07-27 16:07:17 +05:30
Kundan Sable 362c202b25 fix: close remaining front-door-only tool-RBAC gaps (tools_ai, import_export_servers, search_objects, change_password)
Extends the tool-RBAC fix (permission enforced only on a blueprint's
"front door" route, with the rest relying on @pga_login_required alone)
to four permission types the original fix didn't cover:

* tools_ai ("AI Reports"): none of the 14 Security/Performance/Design
  report routes in the llm blueprint checked this permission at all --
  only the frontend menu was hidden behind AllPermissionTypes.TOOLS_AI
  (llm/static/js/ai_tools.js). A user an admin had denied AI access to
  could call the report/report-stream routes directly and have real
  server/database/schema content sent to whichever external LLM
  provider is configured, bypassing both the access control and the
  data-exposure/cost boundary the permission exists to enforce.
* tools_import_export_servers: only 'save' was gated; 'get_servers' and
  'load_servers' relied on @pga_login_required alone. Lower impact than
  the above: get_servers only returns the calling user's own servers,
  and load_servers only previews an already-uploaded file without
  persisting (the actual write stays gated at 'save').
* tools_search_objects: only 'search' was gated; 'types' (a static list
  of supported object-type names for the dropdown, no DB content) was
  not.
* change_password: the self-service password-change route
  (browser.change_password) never checked this permission, so revoking
  "Change Password" from a role in Role management had no effect --
  users under that role could still change their own password. Lower
  severity than the others since the route is inherently self-scoped
  (can only ever affect the caller's own password).

Extends tools/tests/test_tool_permissions_required.py with 17 new
scenarios for the first three, and adds a dedicated
browser/tests/test_change_password_permission_required.py for the last
(different blueprint, different permission category).

Verified against a live PostgreSQL server in SERVER mode: all 40
scenarios (37 + 3) pass with the fix applied. Negative control:
reverting the four fixes reproduces exactly the reported gaps -- 17 of
the 20 pre-existing scenarios still pass unaffected, the 17 new ones
fail, and change_password returns 200 instead of 403 -- confirming the
tests actually catch the regression rather than passing vacuously.
2026-07-27 05:28:57 +00:00
Ashesh Vashi 84b93c268d chore(deps): consolidated dependency bumps (setuptools, fast-uri, tar, shell-quote, svgo) (#10199)
Supersedes 7 open Dependabot PRs by applying the safe ones and
properly fixing the one with a broken lockfile, in one CI cycle:

- setuptools ==82.* -> ==83.* (#10144, #10145 - duplicate PRs, same
  patch). Only touches the `python_version > '3.9'` line; the
  `<82; python_version <= '3.9'` gate for Python 3.9 is untouched,
  so this doesn't affect Python 3.9 support.
- fast-uri 3.1.2 -> 3.1.4 in both /web and /runtime (#10183, #10195)
  - fixes two real CVEs (GHSA-v2hh-gcrm-f6hx, GHSA-4c8g-83qw-93j6).
- tar 7.5.16 -> 7.5.21 (#10182) - patch series, decompression-bomb
  and unbounded-recursion hardening only.
- shell-quote 1.8.4 -> 1.10.0 (#10185) - additive opt-in option +
  parser fixes, no breaking changes.
- svgo 3.3.3 -> 4.0.2 (#10184) - Dependabot's own PR left yarn.lock
  internally inconsistent (dropped the workspace-level `svgo` entry
  while merging version-range blocks), so `yarn install --immutable`
  failed in CI with "the lockfile would have been modified by this
  install". Regenerated properly via `yarn up`/`yarn dedupe` here.
  The direct `svgo`/`svgo-loader` deps are not actually wired into
  any webpack rule (verified via grep) - the real SVG pipeline is
  `@svgr/webpack` -> `@svgr/plugin-svgo` -> svgo 3.3.3, which this
  bump does not touch - so the major version jump has no build
  impact. `yarn.lock` now correctly keeps that separate 3.3.3
  resolution alongside the deduped 4.0.2 one.

Not included (structurally blocked, tracked separately):
- paramiko 3.5.1 -> 5.0.0 (#9927): paramiko 5 removes DSSKey
  entirely; sshtunnel 0.4.0 (dormant since 2021) still references
  paramiko.DSSKey, so `import sshtunnel` would crash immediately.
- pywinpty 2.0.* -> 3.0.* (#10082, #10084): the existing pin cites
  https://github.com/andfoy/pywinpty/issues/545, confirmed still
  open ("process read and write not working as expected in 3.x").

Verified: `yarn install --immutable` clean in both /web and
/runtime, `yarn run linter` clean, full `yarn run bundle:dev`
compiles successfully.
2026-07-25 01:46:48 +05:30
Ashesh Vashi 1e7407bbf6 Merge remote-tracking branch 'origin/master' into cve-9.17-rebase 2026-07-25 01:04:16 +05:30
Ashesh Vashi 9bcc0ff8de docs: fix RST emphasis error in v9.17 release notes
Trailing "SELECT *" broke sphinx's inline emphasis parser (bare *
without matching close), failing the macOS appbundle docs build.
2026-07-25 01:02:36 +05:30
Kundan Sable f75452bfd0 test(security): behavioral regression test for name-literal SQL escaping
Add test_name_literal_sql_escaping.py covering the templates fixed in the
CVE-2026-12044 follow-up: index Statistics (coll_stats.sql, both
dialects), publications (pg + ppas), and subscriptions dependency/
get-position lookups.

Each scenario renders the real template with a stacked-statement
apostrophe payload and asserts (1) the object name appears exactly as
qtLiteral escapes it and (2) the rendered SQL parses as exactly one
statement -- the property that actually prevents statement smuggling.
Verified the semantic assertion fails on the pre-patch raw-interpolation
form (parses as 2 statements) and passes on the fixed form, so the test
genuinely guards the fix rather than trivially passing.

Complements test_stats_template_regclass_cast.py (single-index
pgstatindex path) and the lint guard in test_sql_string_literal_lint.py.
Pure template-render test, no DB required.

Also independently verified during review: the fix's escaping neutralises
a live stacked-statement injection on PostgreSQL 16 (pre-patch slept 5s,
post-patch 0.0s) for both index-stats and pub/sub paths, and confirmed
the browser tree label and Statistics grid render object names as
React-escaped JSX text, so the HTML/XSS probe in an object name does not
execute in those paths. EPAS/ppas runtime path not exercised (ppas
publication templates are byte-identical to the pg variants and are
covered at render level by this test).
2026-07-25 00:55:46 +05:30
Kundan Sable 73b3218992 fix(security): escape index-stats/publication/subscription name sinks (CVE-2026-12044 follow-up)
The 9.16 fix for CVE-2026-12044 hardened qtLiteral and switched sixteen
COMMENT ON / pgstattuple / pgstatindex templates to it, but the fix
missed several sinks that were previously excused in
test_sql_string_literal_lint.py's ALLOWLIST on the (incorrect)
assumption that schema/table/publication/subscription names sourced
from pg_catalog via the browser tree could never contain apostrophes.
They can, since PostgreSQL permits arbitrary characters in quoted
identifiers, so a low-privileged user able to CREATE TABLE, CREATE
PUBLICATION, or CREATE SUBSCRIPTION can plant a name that breaks out of
the unescaped '{{ name }}' interpolation once any user views that
object's Statistics or Dependencies tab.

Switch the following templates to qtLiteral(conn):
- schemas/tables/templates/indexes/sql/{16_plus,default}/coll_stats.sql
  (Index Statistics -- reported as "SQL injection in pgAdmin index
  Statistics (incomplete fix for CVE-2026-12044)")
- publications/templates/publications/{pg,ppas}/default/sql/
  {dependencies,get_position}.sql
- subscriptions/templates/subscriptions/sql/default/
  {dependencies,get_position}.sql

publications/__init__.py and subscriptions/__init__.py now pass
conn=self.conn into the dependencies.sql render_template call so the
qtLiteral filter has a connection to quote against. Remove the
corresponding ALLOWLIST entries in test_sql_string_literal_lint.py now
that these sinks are properly escaped instead of merely assumed safe.

Patch supplied pre-written; manual testing by the reporter reported
both the SQL-injection and HTML-injection probes as positive, but the
exact pre/post-fix state tested was not fully disambiguated in this
session -- treat as reported-but-not-independently-verified pending
follow-up confirmation.
2026-07-25 00:55:46 +05:30
Dave Page 24fdcf0f58 fix(security): add missing auth decorators to Constraints/preferences/debugger/schema_diff routes (CVE-2026-12046 follow-up)
In SERVER mode pgAdmin enforces authentication per route via
@pga_login_required; the before_request hook only handles desktop
auto-login and the Kerberos/Webserver redirect, so a route shipped
without the decorator is reachable unauthenticated (CWE-306). This is
the same defect class as CVE-2026-12046 (the sqleditor close/
update_connection routes).

A sweep found further omissions, now fixed with @pga_login_required:

* Constraints blueprint: nodes, proplist (obj), delete -- the routes
  named in the "SQL injection in pgAdmin index Statistics" follow-up
  report as an incomplete fix for CVE-2026-12046. delete is a
  state-mutating DELETE (removes table constraints); nodes/proplist
  return object information. Adds the missing pga_login_required import
  to this module.
* preferences.get_all_cli (GET)
* debugger.close (DELETE)
* schema_diff.close (DELETE)
2026-07-25 00:55:46 +05:30
Ashesh Vashi e7a8576731 Fix MASTER_PASSWORD_HOOK tokenisation on Windows
posix=False in shlex.split() never strips quote characters, so any
Windows hook path quoted to handle spaces (or any quoted argument)
came out with literal quotes still attached, and unquoted spaced
paths were split into multiple argv elements either way.

Use a shlex.shlex instance with posix=True (correct quote-stripping)
and escape='' (so backslashes in Windows paths are not treated as
escape characters). Document the quoting requirement in config.py
and add regression tests for quoted/unquoted spaced paths.
2026-07-25 00:55:46 +05:30
Dave Page ea7e798aac Fix OS command injection in the MASTER_PASSWORD_HOOK feature
The MASTER_PASSWORD_HOOK setting lets administrators specify an external
command that returns a per-user encryption key, with %u in the configured
string replaced by the current user's name. The previous implementation
substituted the username into the command string and executed the result
with subprocess.Popen(..., shell=True). Because the username can originate
from an external authentication source (OAuth/OIDC claims, Kerberos,
webserver auth), a username containing shell metacharacters allowed an
authenticated user to execute arbitrary commands as the pgAdmin service
account in deployments where the hook uses %u.

Tokenise the trusted hook string into an argument vector first, substitute
the untrusted username into the individual arguments, and execute with
shell=False. The username is therefore always confined to a single argv
element and any shell metacharacters it contains are inert.

Note for administrators: hooks that previously relied on shell features
(pipes, redirection, environment-variable expansion, globbing) in the
MASTER_PASSWORD_HOOK string itself will no longer have those interpreted;
such logic should be moved into the hook script. The documented form,
'<PATH>/script.sh %u', is unaffected.

Adds regression tests covering usernames containing ';', '$()', backticks,
pipes, '&&' and newlines, plus an end-to-end marker-file proof that no
shell execution occurs.

Reported-by: B1gN0Se
2026-07-25 00:55:46 +05:30
Ashesh Vashi 64a9cdbd6a fix: close remaining tool-RBAC gaps found in review
Extends the tool-permission enforcement pattern from the reported CVE
fix to the backup/restore/maintenance/import_export blueprints, which
had the identical front-door-only gap: only create_*_job was gated,
while objects()/check_utility_exists()/get_import_export_settings()
relied on @pga_login_required alone.

Also clears password/save_password/tunnel_password on adhoc server
clones, not just ownership fields - Server.clone() copies every
column, so a non-owner cloning another user's shared server was still
persisting that user's stored credentials into a row the non-owner
now owns.

Adds missing socket test scenarios (erd tables, psql socket_input/
socket_set_role/resize) that the existing test docstring claimed to
cover but didn't.
2026-07-25 00:55:46 +05:30
Dave Page ba1984718a Add RBAC regression tests for tool routes, sockets and adhoc ownership
Add regression coverage for the authorisation fixes:

  * test_tool_permissions_required: a consolidated, per-blueprint check
    that logs in as a user with no roles (hence no tool permissions) and
    asserts every gated backend HTTP route across the query tool, grant
    wizard, schema diff, ERD, PSQL and debugger returns 403. This catches
    any future route added to these blueprints without the decorator.
  * test_tool_socket_permissions_required: asserts the schema diff
    compare_database/compare_schema and psql start_process Socket.IO
    handlers refuse a user lacking the tool permission.
  * test_adhoc_connect_server_ownership: asserts that an adhoc connect
    triggered by a non-owner against an administrator-owned shared server
    persists a server row owned by the caller and not shared.

All three are skipped in DESKTOP mode, where every request is
auto-authenticated as the all-permissions DESKTOP_USER.
2026-07-25 00:55:45 +05:30
Dave Page a7e74a6ed6 Re-home adhoc cloned servers to the calling user
When /misc/workspace/adhoc_connect_server is given a sid, it clones the
existing server. Server.clone() copies every column of the source row,
including user_id, shared and shared_username. When a non-owner triggered
an adhoc connect against an administrator-owned shared server, the clone
inherited the administrator's ownership and shared flag, so pgAdmin
persisted a new, administrator-owned, shared adhoc server row created at
the behest of another user; the row is committed before the connection is
attempted, so it survived even when the connection failed.

Force the cloned adhoc record to belong to the current user and to be
private (user_id, shared, shared_username) before committing, mirroring
the new-server branch, so a non-owner can no longer persist a
cross-tenant server record.
2026-07-25 00:55:45 +05:30
Dave Page d36bd8dc96 Enforce tool RBAC on every backend route, not just the entry point
The tool permissions (tools_query_tool, tools_grant_wizard,
tools_schema_diff, tools_erd_tool, tools_psql_tool, tools_debugger) were
enforced only on a single "front door" route per tool, whilst the rest of
each tool's backend workflow relied on pga_login_required alone. An
authenticated user who had been denied a tool could therefore still drive
the tool through its other routes and Socket.IO handlers:

  * Query Tool: View/Edit Data via sqleditor.initialize_viewdata and the
    rest of the view-data chain, bypassing the gate on initialize_sqleditor.
  * Grant Wizard: object discovery (objects), SQL preview (modified_sql)
    and the actual privilege change (apply) were ungated; only acl_list
    was protected. This allowed real GRANTs to be generated and applied.
  * Schema Diff: initialize, servers, get_server, connect_server,
    connect_database, databases, schemas, ddl_compare and the
    compare_database/compare_schema socket handlers were ungated; only
    panel was protected.
  * ERD: initialize, prequisite, sql (table DDL generation) and the
    tables socket handler were ungated; only panel was protected.
  * PSQL: the panel route and the entire /pty Socket.IO namespace
    (start_process, socket_input, socket_set_role, resize) had no tool
    permission check at all, so a denied user could still obtain an
    interactive psql session.
  * Debugger: the directly addressable get_arguments/set_arguments/
    clear_arguments routes were ungated.

Apply permissions_required to the HTTP routes and socket_permissions_required
to the Socket.IO handlers so the tool permission is enforced consistently
across each tool's surface. The permission check is the outermost
decorator, so it runs before any connection or transaction lookup.
2026-07-25 00:55:45 +05:30
Dave Page 461c3afba9 Add socket_permissions_required decorator for Socket.IO RBAC
Flask-Security's permissions_required only guards HTTP routes; pgAdmin's
Socket.IO event handlers had no permission-aware equivalent and relied on
socket_login_required, which checks authentication but not the tool
permission. Add socket_permissions_required as the socket counterpart of
permissions_required so that event handlers can enforce the same
tool-level RBAC as the routes.

It reads the user's permissions via has_permission() rather than
flask_principal's Permission().can(), so it does not depend on the
principal identity having been loaded onto the socket request context,
and it honours pgAdmin's Administrator bypass. On failure it disconnects
and raises ConnectionRefusedError, mirroring socket_login_required.
2026-07-25 00:55:45 +05:30
Ashesh Vashi 54ff7b4dce Updated message catalogs for v9.17 2026-07-25 00:54:55 +05:30
Ashesh Vashi 5d39a52a73 docs: add release notes for v9.17 2026-07-25 00:21:27 +05:30
Niv Greenstein 108797d48a feat: add custom tile provider settings for Geometry Viewer (#10142)
Geometry Viewer's base-layer choices were hardcoded (Empty, Street,
Topography, Gray Style, Light Color/Dark Matter), with no way to
point at a private/internal tile server or a provider not in that
built-in list.

Add a geometry_viewer preferences category (custom_tile_url, _name,
_crs, _attribution, _max_zoom) under sqleditor. When a valid custom
tile provider URL is configured (must be http(s) and contain {x},
{y}, {z}), it's used as the default base layer; built-in tiled
layers are hidden unless the custom provider's CRS is also
EPSG:3857 (Web Mercator), since they can't be reprojected together.
Non-mercator custom providers (e.g. EPSG:4326) only apply to SRID
4326 geometry data; other SRIDs still render on the existing blank
Cartesian plane.

Custom name/attribution are DOMPurify-sanitized before being passed
to Leaflet (both are innerHTML sinks). URL is not sanitized but is
gated by the http(s):// prefix check, so javascript:/data: URLs are
rejected; it's consumed as a tile-image src template, not an HTML
sink.

Adds GeometryViewerUtils.spec.js covering URL validation, defaults,
sanitization, CRS resolution/fallback, and base-layer composition.
2026-07-24 22:17:51 +05:30
Ashesh Vashi 7339eb8dcc fix: report the correct error message on trigger node.sql failure (#10197)
The failure path for the second query (node.sql, resolving the
trigger function's node data) reported errormsg=rset — the result
dict from the first, already-successful get_function_oid.sql query
— instead of res, the actual error from the failed query. Any
failure here (permissions, catalog access) surfaced a stale,
misleading payload instead of the real cause.
2026-07-24 21:59:06 +05:30
Ashesh Vashi 34108aa50f fix: remove unused sqlalchemy exists import in server_access.py (#10196)
'exists' was imported but never called; the .exists() at line 165 is
the query-builder method on a Query instance, not this function.
2026-07-24 21:58:00 +05:30
lkmatsumura 1e1240038a refactor(server_groups): centralize shared-group visibility and access logic (#10077)
Replace the per-server ServerGroupModule.has_shared_server() loop and
scattered ad hoc shared-server checks with two centralized helpers,
get_server_groups_for_user() and get_server_groups_for_user_query(),
in server_access.py — a single SQL EXISTS query instead of iterating
servers per group. get_server_group() reuses the same shared-access
logic, and returned groups now carry is_shared_group metadata so the
browser tree can render the correct icon and derive edit/delete
permissions consistently.

update() now resolves the target group via get_server_group(gid,
hide_shared=True), so a non-owner can no longer rename another
user's shared group; delete() already blocked deleting shared or
first-user groups and now reports clearer errors for both cases.
Desktop mode's non-SERVER_MODE query path uses
literal(0).label('is_shared_group') (a bare int has no .label()).

Adds test_sg_permissions.py covering owned/shared/desktop group
visibility and access.
2026-07-24 19:11:27 +05:30
Hari Prasad 966a8ae99a docs: add basic starter contributing guide (#10093)
* docs: add basic starter contributing guide

Add a CONTRIBUTING.md file to document the contribution workflow for pgAdmin 4.

Includes:
- Getting started instructions
- Issue reporting guidelines
- Development workflow and coding practices
- Pull request requirements
- Development environment setup
- Database migration guidance
- Security reporting process
- Community support resources

This provides a single reference for new and existing contributors.

* add language tag on the opening fence of the Windows command block

* Add architecture overview, define $PGADMIN4_SRC, and link GitHub URLs

* docs: update contribution guidance

Clarify contributor workflow, fix the runtime link, and add references to existing contributor docs.
2026-07-24 19:05:11 +05:30
Dave Page 75dd304d25 fix(cloud): stop googleapiclient pulling in the system oauth2client (#10110) (#10112)
On packaged Linux installs the bundled venv is created with
--system-site-packages (issue #7173) so it can reach system packages such
as dbus-python. That also exposes the deprecated system oauth2client and
whatever pyOpenSSL ships alongside it. googleapiclient imports oauth2client
optionally, and on Ubuntu 24.04 that drags in a pyOpenSSL too old for our
bundled cryptography, aborting startup at blueprint registration with
"AttributeError: module 'lib' has no attribute 'GEN_EMAIL'".

pgAdmin only ever authenticates to Google via google-auth and
google-auth-oauthlib, so park a None sentinel under
sys.modules['oauth2client'] before importing googleapiclient in both the
web module and the standalone pgacloud provider. The optional import then
fails cleanly and googleapiclient falls back to google-auth.

Closes #10110
2026-07-24 19:02:29 +05:30
n0099 67755809a6 zh_Hans_CN translate: truncate 截断 -> 清空 (#10138)
this also sync with phpmyadmin: https://github.com/phpmyadmin/phpmyadmin/blob/c605fd63bc2e48b682e06d6d1041de544ddf861c/resources/po/zh_CN.po#L12154
2026-07-24 19:01:55 +05:30
Kobi Hikri e65edd4669 Pin sonarqube-scan-action to a full commit SHA (v8.2.1) (#10154) 2026-07-24 19:01:03 +05:30
Kundan 9bf83b4489 fix: return Response as-is and pass conn when expanding a trigger's function (#10177)
Expanding a Trigger node under a Table to view its function threw
'Response' object is not iterable, crashing the tree.

get_children_nodes() can legitimately return a Flask Response instead
of a list (e.g. gone("Could not find the specified trigger
function") when the trigger's function has no matching row in the
trigger-function node query, as happens for a genuine internal-
language function such as suppress_redundant_updates_trigger).
NodeView.children() / PGChildNodeView.children() unconditionally
sorted whatever get_children_nodes() returned, crashing on a
Response instead of passing it through.

Separately, TriggerView.get_children_nodes() rendered the trigger-
function node.sql template (which quotes fnid via qtLiteral(conn))
without passing conn into the template context. This call site
predates qtLiteral requiring a connection; after qtLiteral was
hardened in 658bb585d to raise ValueError instead of silently
degrading when conn is missing, this broke node.sql rendering for
every trigger, not just the internal-language case.

Fix both: check isinstance(children, flask.Response) in children()
before sorting/iterating and return it as-is, and pass
conn=self.conn into the node.sql render call, matching every other
render_template call site in the file.

Fixes #10117
2026-07-24 19:00:31 +05:30
Regina Obe 58e5fc7aed Fix for #10187 (#10188)
Extension UI gives error with PG 19
column reference "comment" is ambiguous LINE 5: e.comment

Issue caused because in pg19 :

SELECT * FROM pg_catalog.pg_available_extensions();

now outputs an additional column `location`
after default_version and comment is now 4th column
2026-07-24 18:38:40 +05:30
Ashesh Vashi 577a518fcb fix: scan all Mach-O binaries for bundle linkage, not just .so/.dylib (#10189)
_verify_bundle_linkage's host-library scan only matched files by
.so/.dylib name suffix, so a shipped executable (Contents/MacOS/*)
or a Python.framework payload with a host-linked dependency but no
matching suffix could slip through unchecked — the same class of
bug #10135 was added to catch.

Detect Mach-O executables/libraries by content via `file` instead
(same pattern the codesign step in this file already uses),
regardless of extension or executable permission bits, so readable
non-executable dylibs are covered too.
2026-07-24 18:34:03 +05:30
Dave Page 1884356245 fix: fail the macOS build if any bundled library links outside the bundle (#10135)
9.16 failed to start on Intel Macs (#10123): cryptography had no
prebuilt Intel macOS wheel, pip compiled it from source, and its
openssl-sys build linked the builder's Homebrew OpenSSL into
_rust.abi3.so instead of the bundled one. _fixup_imports deliberately
skips _rust.abi3.so, so the dangling reference shipped unnoticed and
the app died on startup for anyone without that external dylib.

Add _verify_bundle_linkage, run after the bundle is assembled and
relocated but before code-signing: walks every .so/.dylib and fails
the build if any install-name points at a build-host prefix
(/usr/local, /opt/homebrew, /opt/local, $SLAVE_HOME). OS libraries
and @loader_path/@rpath/@executable_path references pass untouched.
Turns this class of bug into a build-time failure instead of a
runtime one.
2026-07-24 18:22:08 +05:30
Kundan b85fb6c650 fix: use pg_depend ownership instead of name guessing for SERIAL detection (#10167)
Column-owns-sequence was detected by guessing the sequence name as
<table>_<col>_seq and string-matching it in nextval(...). Renaming
a table/column broke the guess (false negative, #10100); an
unrelated sequence with the same guessed name broke it the other
way (false positive, #10101).

Check col.get('seqrelid') (real pg_depend ownership) instead, and
exclude identity columns. SERIAL is now emitted iff a genuine
ownership dependency exists, independent of naming.

Fixes #10100, #10101
2026-07-24 18:15:20 +05:30
Kundan 5ff4f694fd fix: Schema Diff filter chip toggle broadcasting stale empty selection (#10172)
selectFilterOption() computed newOptions inside the functional
setSelectedFilters(prev => {...}) updater, then used that same
variable to dispatch TRIGGER_CHANGE_FILTER synchronously. Since the
updater runs lazily on next render, every chip toggle broadcast an
empty filter, so the tree always showed "No difference found" until
a full re-Compare.

Compute the new selection synchronously from current state and use
it for both the state update and the dispatched event.

Fixes #10102
2026-07-24 18:14:22 +05:30
hiteshjambhale f9935b3da5 fix: honor selected EOL sequence when copying query text to clipboard (#10160)
getSelectionFromState() joined ranges with the chosen EOL but sliced
each range via state.sliceDoc(), which always uses the document's
own \n regardless of the LF/CRLF preference. Introduced in #8691
when the copy path switched from doc.sliceString(..., lineSep) to
sliceDoc(...) to fix multi-cursor copying.

Slice with state.doc.sliceString(range.from, range.to, lineSep) so
the chosen EOL applies within a range too; the #8691 multi-cursor
join behavior is unchanged.

Fixes #10158
2026-07-24 18:13:27 +05:30
Dave Page cec1b38b2f fix: warn when OAuth2 provider settings are misplaced at the top level of config (#10113)
OAuth2 provider settings are only read from the OAUTH2_CONFIG list;
bare top-level keys like OAUTH2_CLIENT_ID or
OAUTH2_SSL_CERT_VERIFICATION are silently ignored. This is an easy
trap in container deployments where every other option is set via
an individual PGADMIN_CONFIG_<KEY> env var.

Add warn_on_misplaced_oauth2_config(), called once at OAuth2 module
startup, that logs when per-provider OAUTH2_* keys exist at the top
level with no provider configured in OAUTH2_CONFIG. No behavior
change for correctly configured or unconfigured deployments.
Documents the supported container approach in oauth2.rst.

Closes #10053
2026-07-24 18:12:22 +05:30
Kundan 6f8be955a1 fix: render disconnect tree label via className, not embedded HTML (#10169)
Disconnect handlers in server.js/database.js built the transitional
tree-node label as an HTML string and passed it to setLabel(), which
writes via label.textContent — correctly escaping markup, so the
literal "<span class='text-muted'>[Disconnecting...]</span>" text
was shown instead of a greyed-out label.

Pass plain text plus a className: 'text-muted' instead; setLabel()
applies the className to the label span (default file-name class
otherwise), so muted styling comes from CSS, not injected markup.

Fixes #10106
2026-07-24 18:11:22 +05:30
Kundan 49e955a855 feat: add preference for default View Data row limit (#10170)
The unqualified "View Data" action always ran with no LIMIT, unlike
"First/Last 100 Rows" which hardcode limit=100 — unusable on large
tables with no way to cap it.

Add view_data_default_row_limit preference (int, default 0 =
unlimited) under sqleditor Options. GridCommand.__init__ applies it
as self.limit when cmd_type == VIEW_ALL_ROWS and the value is
positive; objectquery.sql already renders LIMIT only when > 0, so
no template changes needed. First/Last 100 Rows untouched.

Closes #10104
2026-07-24 18:10:13 +05:30
Kundan 6ad6024bca fix: detect a selected-but-unusable OS keyring and fall back gracefully (#10168)
evaluate_and_patch_config() only disabled USE_OS_SECRET_STORAGE when
keyring.get_keyring().name == 'fail Keyring'. On Debian 13 over RDP, a
real backend (e.g. SecretService) is selected because no D-Bus/GNOME
Keyring session is running, so the name check passes even though every
actual keyring call fails — leaving the crypt key unset and every
operation raising a bare CryptKeyMissing.

Probe the selected backend with a harmless read of a never-existing
entry after selection. A healthy backend returns None without
prompting; an unusable one raises, and we disable
USE_OS_SECRET_STORAGE so the app falls back to the master-password /
in-app crypt key mechanism instead of failing outright.

Fixes #10107
2026-07-24 18:08:27 +05:30
Kundan aeef9c2d80 fix: ALT+F5 not falling back to statement under cursor (#10173)
triggerExecution() only fell back to getQueryAt(cursor) when
getSelection() was falsy. Since #7293/#8691 (non-continuous
highlighted-block support), getSelection() flattens and joins all
ranges, so multiple empty cursor ranges can produce a truthy but
whitespace-only string (e.g. "\n"), skipping the fallback entirely —
ALT+F5 silently tried to execute whitespace. Same stale check existed
in checkUnderlineQueryCursorWarning(). Also fixes a latent
state.selection.head reference (EditorSelection has no such
property; correct field is state.selection.main.head).

Treat a whitespace-only selection as empty before the fallback check
in both functions. Real highlighted selections always contain
non-whitespace, so #7293/#9570 behavior is unaffected.

Fixes #10109
2026-07-24 18:07:26 +05:30
Ashesh Vashi 8812025a8a chore(deps): Bump patch/minor dependency bumps (#10176)
Consolidates 20 open dependabot PRs (JS + Python) into one bump, applied
directly rather than cherry-picked (PR branches were stale and would have
reverted unrelated fixes like the yarn packageManager pin). Adds further
same-major patch/minor bumps found by auditing beyond dependabot's own PR
list.

JS (web + runtime): axios, brace-expansion, form-data, undici, js-yaml,
dompurify, @babel/core, webpack, sharp, electron, eslint, react-checkbox-tree,
autoprefixer, eslint-plugin-jest, globals, jest, jest-environment-jsdom, svgo,
terser-webpack-plugin, typescript-eslint, webpack-bundle-analyzer,
@date-io/date-fns, @szhsin/react-menu, @tanstack/react-query, @types/react,
ajv, anti-trojan-source, ip-address, marked, moment-timezone, papaparse,
postcss, react, react-dom, react-draggable, react-timer-hook, sql-formatter,
zustand.

Python: certifi, selenium (version-gated: 4.45.0 requires Python >=3.10,
4.44.0 kept for <=3.9 to preserve Python 3.9 support).

Reverted / excluded, with reasons:
- azure-mgmt-resource 26.0.0: moved ResourceManagementClient from
  azure.mgmt.resource to azure.mgmt.resource.resources, breaking
  pgadmin/misc/cloud/azure/__init__.py at import time. Caught by the Python
  regression suite. Kept at 25.0.0.
- @simonwep/pickr 1.10.0: switched its build tool to tsup, which marks its
  UMD bundle as an ES module via Symbol.toStringTag instead of the
  __esModule flag Babel's interop helper checks for. Babel double-wraps the
  export, so `new Pickr(...)` resolves to a non-constructor and crashes
  every dialog that mounts a color picker -- reproduces only in the
  production/minified webpack build, not the dev bundle or Jest. Pinned to
  ~1.9.1 (tilde, not caret) so a future install can't silently float back to
  1.10.x.
- paramiko 3->5 (#9927): structurally blocked by sshtunnel 0.4.0 still
  referencing paramiko.DSSKey.
- @mui/material / @mui/x-date-pickers 7/8->9 (#10091, #10092): known
  UI-breaking, needs the accompanying component fixes tracked on a separate
  branch, not a bare version bump.
- react-arborist, @tanstack/react-virtual, react-frame-component: same-major
  bumps available but excluded -- core object-browser tree, already-fragile
  virtualization code, or tilde-pinned range respectively.
- A handful of JS packages hit Yarn 4.15's registry quarantine gate (blocks
  just-published versions); backed off to the next-older version instead of
  forcing through.

Added core-js as an explicit devDependency: it was never declared despite
webpack's Babel config (useBuiltIns: 'usage', corejs: 3) requiring it --
it only worked because @simonwep/pickr 1.9.1 happened to pull it in
transitively, which broke when pickr was briefly bumped.

Verified: eslint (web + runtime), full JS test suite (149/149 suites,
916/916 tests), webpack production build compiles clean, Python regression
suite (2388/2388, excl. Selenium), Selenium feature_tests (17/19 pass; the
2 failures trace to a local pldbgapi-extension gap, unrelated to any
bumped dependency).
2026-07-23 15:28:38 +05:30
Ashesh Vashi 1993109475 fix: pin Yarn version from packageManager field in remaining build scripts (#10175)
#10156 fixed CI build failures caused by Yarn 4.x fetching a newer patch
with different builtin compat hashes, breaking --immutable lockfile
validation, but only patched pkg/linux/build-functions.sh and the GHA
workflows. Make.bat, pkg/mac/build-functions.sh, pkg/pip/build.sh, and
Dockerfile still hardcoded 'yarn set version 4', which is what broke the
Windows Jenkins snapshot build (job 1669).
2026-07-23 13:06:29 +05:30
Ashesh Vashi b15c745dc1 fix: pin Yarn version from packageManager field in build scripts (#10156)
* fix: pin Yarn version from packageManager field in build scripts

Replace hardcoded 'yarn set version 4' in build-functions.sh with a
dynamic lookup from each workspace's package.json packageManager field.
Also syncs runtime yarn version to 4.15.0 to match web/package.json.

Fixes CI build failures caused by Yarn 4.x fetching a newer patch that
produces different builtin compat hashes, breaking --immutable lockfile
validation.
2026-07-16 11:48:36 +05:30
Luiz K Matsumura dfc4ef37d0 refactor: clarify ServerGroup relationships to Server and SharedServer (#10076)
The Server and SharedServer models each declared a relationship named
'servers' that actually pointed at the parent ServerGroup, with backrefs
('server'/'sharedserver') providing the collections. The naming was the
inverse of what it modelled and made the call sites read oddly.

Redefine the relationships in the natural direction using explicit
back_populates: ServerGroup gains 'servers' and 'sharedservers'
collections (carrying the existing delete-orphan cascade), and Server and
SharedServer each gain a 'servergroup' reference. The two call sites that
read the group name are updated from server.servers.name to
server.servergroup.name accordingly.

This is a naming/modelling cleanup with no functional or schema change, so
no migration is required.
2026-06-19 10:32:02 +01:00
somaz 7e76fb4eb0 Add Gateway API HTTPRoute support to the Helm chart (#10095)
Add an opt-in Gateway API HTTPRoute template to the Helm chart as an
alternative to the existing Ingress, addressing #9942. It is disabled by
default (httpRoute.enabled: false) so existing installs are unaffected.

The template mirrors the existing ingress.yaml conventions: the
pgadmin4.fullname backend, commonLabels/commonAnnotations propagation, and
a hostname that falls back to ingress.hostname when httpRoute.hostnames is
unset. parentRefs is required (a fail guard fires when it is empty),
apiVersion defaults to gateway.networking.k8s.io/v1, and the default rule
forwards "/" (PathPrefix) to the pgAdmin service. Custom hostnames and
rules can be supplied for full control. The new values are documented in
the chart README.
2026-06-19 09:41:54 +01:00
Jeremy Schneider 0c6740f146 feat: include authenticated user identity in HTTP access log (#9991)
Set an X-Remote-User response header containing the authenticated username
on every request when the LOG_AUTHENTICATED_USER config option is enabled
(disabled by default). This allows the HTTP access log to be configured to
include user identity via standard log format directives
(%({x-remote-user}o)s in gunicorn, %{X-Remote-User}o in Apache) without
requiring any changes to pgAdmin's session or authentication behaviour. The
default gunicorn access log format is updated to surface the header.

The username is sanitised to a header-safe value: it is transliterated to
Latin-1 (HTTP headers are Latin-1 only) and any non-printable characters,
including CR/LF, are stripped, so unusual usernames cannot cause a 500 on
every response.
2026-06-19 09:26:32 +01:00
869 changed files with 129284 additions and 44542 deletions

No files matched your search

+5
View File
@@ -1,2 +1,7 @@
# Auto detect text files and normalize end of lines to LF (\n)
* text=auto eol=lf
# Make.bat has always been stored with CRLF; the blanket eol=lf above would
# silently rewrite the whole file the first time anything touches it.
Make.bat -text
pkg/win32/*.bat text eol=crlf
@@ -0,0 +1,338 @@
# Installs the PostgreSQL build dependencies published by pgadmin-org/pgbuild.
#
# Four workflows need these — the QA and snapshot builds on each of macOS and
# Windows — and keeping the logic in one place is not merely tidiness: the
# first version used the gh CLI, which turned out not to exist on the
# self-hosted Windows runner, and that same fix had to be made twice.
#
# On macOS the archives must land in /opt/pgbuild specifically, because the
# install names inside them are absolute: pg_dump asks for
# /opt/pgbuild/zstd/lib/libzstd.1.dylib and libpq for
# /opt/pgbuild/krb5/lib/libgssapi_krb5.2.2.dylib, among others. _fixup_imports
# copies from those paths into the bundle and rewrites the references, so they
# have to resolve at build time. On Windows there are no absolute references,
# so the location only has to avoid colliding with anything else, which is why
# it goes under the runner's temp directory rather than the C:\build64 the
# buildfarm's Jenkins worker manages.
#
# Everything is fetched over plain HTTPS. pgbuild is public and its asset URLs
# are predictable, so this needs neither a CLI nor authentication, and both
# curl --fail and Invoke-WebRequest fail on a 404 rather than writing an error
# page to disk and failing later at the unpack.
#
# What gets downloaded is decided by pkg/pgbuild-deps.lock rather than by the
# rolling -latest tags, whose assets pgbuild replaces in place on every
# rebuild. Building from those means that what is Authenticode signed on
# Windows and Developer ID signed and notarised on macOS is whatever pgbuild
# happened to be publishing that morning, which is neither reproducible nor
# something anybody reviewed. The lock names a per-version tag and the SHA-256
# of its archive, and an archive that does not hash to the recorded digest, or
# that has no lock entry at all, fails the build rather than being unpacked
# unverified. pgbuild publishes a .sha256 beside each archive, which is
# deliberately not consulted: whoever rebuilds an archive rebuilds that too, so
# it is a convenience rather than a source of trust, and the lock is the only
# thing here that pins anything.
#
# Being out of date is a different thing from being wrong, so once an archive
# has been verified, pgbuild's releases are consulted to see whether a newer
# build of that dependency exists, and if one does the job carries a warning
# naming it. It stays a warning, because the build goes on to ship the pinned
# version and a dependency published overnight is no reason to turn pgAdmin
# red, and the check is best effort, so an API that will not answer leaves a
# build whose downloads are already verified alone.
# tools/refresh_pgbuild_lock.py is what turns such a warning into a reviewed
# commit.
name: Install pgbuild dependencies
description: Download and unpack the PostgreSQL build dependencies from pgadmin-org/pgbuild
inputs:
arch:
description: Architecture as pgbuild names it, e.g. arm64, x86_64
required: true
postgres-major:
description: PostgreSQL major version to install
required: false
default: '18'
outputs:
prefix:
description: Directory the dependencies were unpacked into
# Whichever of the two platform steps ran. Merging these in a shell step
# instead would mean picking a shell that exists on every runner, and the
# Windows signing host has no bash.
value: ${{ steps.install-macos.outputs.prefix || steps.install-windows.outputs.prefix }}
runs:
using: composite
steps:
- name: Install the pgbuild dependencies (macOS)
id: install-macos
if: runner.os == 'macOS'
shell: bash
env:
PGBUILD_ARCH: ${{ inputs.arch }}
POSTGRES_MAJOR: ${{ inputs.postgres-major }}
# Only so that the out-of-date check does not run into the
# unauthenticated rate limit, which is shared with everything else
# coming from a hosted runner's address and would leave the warning
# firing only sometimes. Nothing else here needs authentication,
# pgbuild being public.
GH_TOKEN: ${{ github.token }}
run: |
set -euo pipefail
BASE=https://github.com/pgadmin-org/pgbuild/releases/download
RELEASES=https://api.github.com/repos/pgadmin-org/pgbuild/releases
# GITHUB_ACTION_PATH rather than the workspace, so that the lock is
# found even where a workflow checks the repository out somewhere
# other than the default directory.
LOCK="${GITHUB_ACTION_PATH}/../../../pkg/pgbuild-deps.lock"
# The hosted macOS images have shasum, which comes with the system
# perl, but not sha256sum, whereas a Linux-alike self-hosted runner is
# the other way about, so take whichever is there.
if command -v shasum > /dev/null; then
sha256() { shasum -a 256 "$1" | cut -d' ' -f1; }
else
sha256() { sha256sum "$1" | cut -d' ' -f1; }
fi
# Column 2 of a lock line is the tag to fetch and column 3 the digest
# its archive must hash to. Trailing comments are stripped first,
# which also rebuilds awk's idea of the fields.
lock_field() {
awk -v key="$1" -v col="$2" '
{ sub(/#.*/, "") }
$1 == key { print $col; exit }
' "${LOCK}"
}
# pgbuild's tags, newest first, for the out-of-date check below. This
# is deliberately best effort: a build whose downloads have been
# verified must not fail because GitHub would not say what else has
# been published since.
TAGS="${RUNNER_TEMP}/pgbuild-tags.txt"
: > "${TAGS}"
if ! curl --fail --silent --location --max-time 30 \
-H "Accept: application/vnd.github+json" \
${GH_TOKEN:+-H "Authorization: Bearer ${GH_TOKEN}"} \
"${RELEASES}?per_page=100" \
| grep -o '"tag_name": *"[^"]*"' \
| sed 's/.*"\(.*\)"/\1/' > "${TAGS}"; then
echo "Could not list pgbuild's releases, so this build will not"
echo "report whether its pinned dependencies are still current."
fi
sudo mkdir -p /opt/pgbuild
sudo chown "$(id -u):$(id -g)" /opt/pgbuild
for PKG in openssl krb5 zstd lz4 "postgresql-${POSTGRES_MAJOR}"; do
KEY="${PKG}-macos-${PGBUILD_ARCH}"
TAG=$(lock_field "${KEY}" 2)
EXPECTED=$(lock_field "${KEY}" 3)
if [ -z "${TAG}" ] || [ -z "${EXPECTED}" ]; then
echo "ERROR: ${KEY} has no entry in pkg/pgbuild-deps.lock"
echo
echo "An unpinned dependency must not reach a build we sign,"
echo "so this is a failure rather than a warning. Add it with:"
echo
echo " tools/refresh_pgbuild_lock.py ${PKG%%-*}"
echo
echo "If this is a PostgreSQL major the lock has never seen,"
echo "add it to POSTGRES_MAJORS in that script first."
exit 1
fi
ARCHIVE="${TAG}.tar.gz"
echo "Fetching ${ARCHIVE}..."
curl --fail --silent --show-error --location \
-o "${RUNNER_TEMP}/${ARCHIVE}" "${BASE}/${TAG}/${ARCHIVE}"
ACTUAL=$(sha256 "${RUNNER_TEMP}/${ARCHIVE}")
if [ "${ACTUAL}" != "${EXPECTED}" ]; then
echo "ERROR: checksum mismatch for ${ARCHIVE}"
echo " expected: ${EXPECTED}"
echo " actual: ${ACTUAL}"
echo
echo "The bytes behind ${TAG} are not the"
echo "ones that were reviewed when the lock was written."
echo "Usually that means pgbuild rebuilt the tag in place,"
echo "which it does for PostgreSQL whenever a new minor comes"
echo "out, that tag carrying only the major. Satisfy yourself"
echo "that a rebuild is what happened before re-running,"
echo "because this is also the one check standing between a"
echo "tampered dependency and a signed pgAdmin build, and then"
echo "record the new archive, read the diff and commit it:"
echo
echo " tools/refresh_pgbuild_lock.py ${PKG%%-*}"
exit 1
fi
echo "Verified ${ARCHIVE} (sha256 ${ACTUAL})"
# The first tag of the right shape is the newest, the listing
# coming back in reverse chronological order. The rolling tag is
# skipped because it names no version.
NEWEST=""
while read -r CANDIDATE; do
case "${CANDIDATE}" in
*-latest)
continue
;;
${PKG}*-macos-${PGBUILD_ARCH})
NEWEST="${CANDIDATE}"
break
;;
esac
done < "${TAGS}"
if [ -n "${NEWEST}" ] && [ "${NEWEST}" != "${TAG}" ]; then
echo "::warning title=pgbuild dependency out of date::${KEY} is pinned to ${TAG}, but pgbuild has since published ${NEWEST}. This build is using the pinned version, which is what the lock file is for, and nothing is broken. To move to the newer build, run tools/refresh_pgbuild_lock.py ${PKG%%-*}, review the change to pkg/pgbuild-deps.lock and commit it."
fi
tar -xzf "${RUNNER_TEMP}/${ARCHIVE}" -C /opt/pgbuild
done
ls -l /opt/pgbuild
echo "prefix=/opt/pgbuild" >> "${GITHUB_OUTPUT}"
- name: Install the pgbuild dependencies (Windows)
id: install-windows
if: runner.os == 'Windows'
shell: powershell
env:
PGBUILD_ARCH: ${{ inputs.arch }}
POSTGRES_MAJOR: ${{ inputs.postgres-major }}
# See the macOS step: this is for the out-of-date check's rate limit
# alone, and the downloads themselves need no authentication.
GH_TOKEN: ${{ github.token }}
run: |
# Without this, Invoke-WebRequest spends most of a 90 MB download
# rendering a progress bar into a log nobody will read.
$ProgressPreference = 'SilentlyContinue'
$base = 'https://github.com/pgadmin-org/pgbuild/releases/download'
$releases = 'https://api.github.com/repos/pgadmin-org/pgbuild/releases'
# GITHUB_ACTION_PATH rather than the workspace, so that the lock is
# found even where a workflow checks the repository out somewhere
# other than the default directory.
$lock = Join-Path $env:GITHUB_ACTION_PATH '..\..\..\pkg\pgbuild-deps.lock'
# Column 2 of a lock line is the tag to fetch and column 3 the digest
# its archive must hash to; anything after a # is a comment.
function Get-LockEntry($key) {
foreach ($line in Get-Content $lock) {
$text = ($line -split '#', 2)[0].Trim()
if ($text -eq '') { continue }
$fields = $text -split '\s+'
if ($fields.Count -eq 3 -and $fields[0] -eq $key) {
return @{ Tag = $fields[1]; Digest = $fields[2] }
}
}
return $null
}
# pgbuild's tags, newest first, for the out-of-date check below. This
# is deliberately best effort: a build whose downloads have been
# verified must not fail because GitHub would not say what else has
# been published since.
$tags = @()
try {
$headers = @{ 'Accept' = 'application/vnd.github+json' }
if ($env:GH_TOKEN) {
$headers['Authorization'] = "Bearer $env:GH_TOKEN"
}
$tags = (Invoke-RestMethod -Uri "${releases}?per_page=100" -Headers $headers -UseBasicParsing) | ForEach-Object { $_.tag_name }
} catch {
Write-Output "Could not list pgbuild's releases, so this build will not"
Write-Output "report whether its pinned dependencies are still current."
}
# The first tag of the right shape is the newest, the listing coming
# back in reverse chronological order. The rolling tag is skipped
# because it names no version.
function Get-NewestTag($pattern) {
foreach ($tag in $tags) {
if ($tag -like '*-latest') { continue }
if ($tag -like $pattern) { return $tag }
}
return $null
}
$depsDir = Join-Path $env:RUNNER_TEMP 'pgbuild-deps'
New-Item -ItemType Directory -Force -Path $depsDir | Out-Null
foreach ($pkg in @("postgresql-$env:POSTGRES_MAJOR", 'krb5')) {
$key = "$pkg-windows-$env:PGBUILD_ARCH"
$pin = Get-LockEntry $key
$family = ($pkg -split '-')[0]
if (-not $pin) {
Write-Output "ERROR: $key has no entry in pkg/pgbuild-deps.lock"
Write-Output ""
Write-Output "An unpinned dependency must not reach a build we sign,"
Write-Output "so this is a failure rather than a warning. Add it with:"
Write-Output ""
Write-Output " tools/refresh_pgbuild_lock.py $family"
Write-Output ""
Write-Output "If this is a PostgreSQL major the lock has never seen,"
Write-Output "add it to POSTGRES_MAJORS in that script first."
exit 1
}
$archive = "$($pin.Tag).zip"
$zip = Join-Path $env:RUNNER_TEMP $archive
Write-Output "Fetching $archive..."
Invoke-WebRequest -Uri "$base/$($pin.Tag)/$archive" -OutFile $zip -UseBasicParsing
$actual = (Get-FileHash -Algorithm SHA256 -Path $zip).Hash.ToLower()
if ($actual -ne $pin.Digest) {
Write-Output "ERROR: checksum mismatch for $archive"
Write-Output " expected: $($pin.Digest)"
Write-Output " actual: $actual"
Write-Output ""
Write-Output "The bytes behind $($pin.Tag) are not the"
Write-Output "ones that were reviewed when the lock was written."
Write-Output "Usually that means pgbuild rebuilt the tag in place,"
Write-Output "which it does for PostgreSQL whenever a new minor comes"
Write-Output "out, that tag carrying only the major. Satisfy yourself"
Write-Output "that a rebuild is what happened before re-running,"
Write-Output "because this is also the one check standing between a"
Write-Output "tampered dependency and a signed pgAdmin build, and then"
Write-Output "record the new archive, read the diff and commit it:"
Write-Output ""
Write-Output " tools/refresh_pgbuild_lock.py $family"
exit 1
}
Write-Output "Verified $archive (sha256 $actual)"
$newest = Get-NewestTag "$pkg*-windows-$env:PGBUILD_ARCH"
if ($newest -and $newest -ne $pin.Tag) {
Write-Output "::warning title=pgbuild dependency out of date::$key is pinned to $($pin.Tag), but pgbuild has since published $newest. This build is using the pinned version, which is what the lock file is for, and nothing is broken. To move to the newer build, run tools/refresh_pgbuild_lock.py $family, review the change to pkg/pgbuild-deps.lock and commit it."
}
Expand-Archive -Path $zip -DestinationPath $depsDir -Force
}
Get-ChildItem $depsDir
# Out-File in Windows PowerShell defaults to UTF-16, which the runner
# cannot parse, so the encoding is explicit.
"prefix=$depsDir" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append
+82
View File
@@ -1,4 +1,11 @@
version: 2
# A note on the "groups" blocks below: minor and patch updates are batched into
# a single PR per manifest per week, whilst major updates continue to arrive
# individually. Majors are where the breakage lives and each one wants its own
# review, whereas a dozen separate PRs for patch bumps is pure overhead.
# Grouping applies to version updates only, so Dependabot security updates are
# unaffected and still arrive as their own PRs.
updates:
- package-ecosystem: "docker"
directory: "/"
@@ -17,6 +24,20 @@ updates:
- "Dependencies"
commit-message:
prefix: "Python dependency"
groups:
python-minor-and-patch:
patterns:
- "*"
update-types:
- "minor"
- "patch"
# paramiko 5.0 removed DSSKey, which sshtunnel 0.4.0 still references in
# SSHTunnelForwarder.get_keys(); a major bump therefore breaks every SSH
# tunnelled connection at construction time. sshtunnel has had no release
# since 2019, so this stays put until it is fixed or replaced. See #9927.
ignore:
- dependency-name: "paramiko"
update-types: ["version-update:semver-major"]
- package-ecosystem: "pip"
directory: "/tools"
@@ -26,7 +47,17 @@ updates:
- "Dependencies"
commit-message:
prefix: "Python dependency"
groups:
tools-python-minor-and-patch:
patterns:
- "*"
update-types:
- "minor"
- "patch"
# Note that web/regression/requirements.txt begins with
# "-r ../../requirements.txt", so this entry also sees everything pinned in
# the root file and the paramiko exclusion has to be repeated here.
- package-ecosystem: "pip"
directory: "/web/regression"
schedule:
@@ -35,6 +66,16 @@ updates:
- "Dependencies"
commit-message:
prefix: "Python dependency"
groups:
regression-python-minor-and-patch:
patterns:
- "*"
update-types:
- "minor"
- "patch"
ignore:
- dependency-name: "paramiko"
update-types: ["version-update:semver-major"]
- package-ecosystem: "npm"
directory: "/runtime"
@@ -44,6 +85,13 @@ updates:
- "Dependencies"
commit-message:
prefix: "Javascript dependency"
groups:
runtime-javascript-minor-and-patch:
patterns:
- "*"
update-types:
- "minor"
- "patch"
- package-ecosystem: "npm"
directory: "/web"
@@ -53,3 +101,37 @@ updates:
- "Dependencies"
commit-message:
prefix: "Javascript dependency"
groups:
web-javascript-minor-and-patch:
patterns:
- "*"
update-types:
- "minor"
- "patch"
ignore:
# @testing-library/jest-dom 7 requires Node >= 22, whilst Node 20 is the
# minimum we support and what most of the buildfarm runs. Revisit once
# the buildfarm moves to Node 22. See #10271 and #10210.
- dependency-name: "@testing-library/jest-dom"
update-types: ["version-update:semver-major"]
# Babel 8 requires Node ^22.18.0 || >=24.11.0, and every 8.x package
# peer-depends on @babel/core ^8.0.0 whilst we are on 7.x. Taking any of
# them individually leaves an unsatisfiable peer requirement and a mixed
# 7/8 tree, so Babel 8 needs a coordinated migration across all ten
# @babel/* packages once we are on Node 22. See #10283, #10284, #10285.
- dependency-name: "@babel/*"
update-types: ["version-update:semver-major"]
# pickr 1.10 switched to a dual CJS/ESM build whose CommonJS entry point
# exports a namespace object rather than the class, so Babel's interop
# leaves _pickr.default as an object and every dialog with a colour field
# dies on mount. That took master's feature tests down for three days
# (#10264, reverted in #10278). Note 1.9 -> 1.10 is a *minor* bump, so it
# otherwise rejoins the grouped PR and comes back around; minor updates
# are excluded here as well as majors until withColorPicker.js is adapted
# to the new export shape.
- dependency-name: "@simonwep/pickr"
update-types:
- "version-update:semver-major"
- "version-update:semver-minor"
+431
View File
@@ -0,0 +1,431 @@
# Install pgAdmin from a published tree, exactly as the README tells a user to.
#
# Everything else in this pipeline checks that files exist, that indexes parse
# and that signatures validate. All three can be true of a repository apt still
# refuses, and two bugs found during the migration were of precisely that
# shape: packages one directory too deep, and noarch RPMs filed where no dnf
# client looks. Neither failed a build.
#
# So this does not inspect anything. It follows the instructions in the
# repository README, in a clean container, and installs the package. No
# --allow-unauthenticated, no --nogpgcheck, no pinning: if the signature is
# wrong or the architecture is missing from Release, the install fails, which
# is the point.
#
# It runs against a release candidate on the development server, which serves
# its tree the moment it is written. The download server sits behind an hourly
# sync to the mirrors, so testing there would mostly measure the sync.
name: Acceptance test
on:
workflow_call:
inputs:
base-url:
description: The tree to install from, without a trailing slash
required: true
type: string
workflow_dispatch:
inputs:
base-url:
description: >-
The tree to install from, for example
https://developer.pgadmin.org/builds/2026-09-21-1
required: true
type: string
concurrency:
group: 'acceptance-test @ ${{ inputs.base-url }}'
cancel-in-progress: true
permissions:
contents: read
jobs:
# The URL is fetched from, installed from and, in the apt job, written into
# a file, so it is checked once here rather than trusted in nine places. The
# host allowlist is the point: everything below downloads and then installs
# as root whatever that host serves, so this is what decides who gets to ask
# for that.
check:
runs-on: ubuntu-24.04
steps:
- name: Check the base URL
env:
BASE_URL: ${{ inputs.base-url }}
run: |
set -euo pipefail
case "${BASE_URL}" in
https://developer.pgadmin.org/builds/*) ;;
https://ftp.postgresql.org/pub/pgadmin/pgadmin4/*) ;;
*)
echo "Not a tree this test will install from: ${BASE_URL}" >&2
echo "Expected developer.pgadmin.org or ftp.postgresql.org." >&2
exit 1 ;;
esac
# No trailing slash, no shell metacharacters, nothing that could be
# read as a second word: the value is interpolated into commands.
printf '%s' "${BASE_URL}" | grep -Eq '^https://[A-Za-z0-9./_-]+[A-Za-z0-9]$' || {
echo "The base URL may contain only letters, digits, dot, slash, underscore and hyphen." >&2
exit 1; }
apt:
needs: check
runs-on: ubuntu-24.04
# The images default to sh, which has no pipefail, so every step that set
# it died on the first line. All of these carry bash.
defaults:
run:
shell: bash
strategy:
fail-fast: false
matrix:
include:
- { name: 'bookworm', image: 'debian:12' }
- { name: 'trixie', image: 'debian:13' }
- { name: 'jammy', image: 'ubuntu:22.04' }
- { name: 'noble', image: 'ubuntu:24.04' }
- { name: 'resolute', image: 'ubuntu:26.04' }
container: ${{ matrix.image }}
steps:
# Only what a user would already have or would obviously need. lsb-release
# is here because the README's own sources.list line calls lsb_release,
# and following the instruction is the test.
- name: Install the prerequisites
env:
DEBIAN_FRONTEND: noninteractive
run: |
apt-get update
apt-get install -y --no-install-recommends ca-certificates curl gnupg lsb-release
- name: Follow the README
env:
BASE_URL: ${{ inputs.base-url }}
DEBIAN_FRONTEND: noninteractive
run: |
set -euo pipefail
curl -fsS https://www.pgadmin.org/static/packages_pgadmin_org.pub \
| gpg --dearmor -o /usr/share/keyrings/packages-pgadmin-org.gpg
# Written by this shell rather than handed to `sh -c`, which
# re-parsed the expanded URL as source and was the one place in the
# pipeline where a caller-supplied value reached a shell.
CODENAME=$(lsb_release -cs)
echo "deb [signed-by=/usr/share/keyrings/packages-pgadmin-org.gpg] ${BASE_URL}/apt/${CODENAME} pgadmin4 main" \
> /etc/apt/sources.list.d/pgadmin4.list
cat /etc/apt/sources.list.d/pgadmin4.list
# A repository apt will not verify makes this fail here, before any
# package is considered.
apt-get update
- name: Install pgAdmin
env:
DEBIAN_FRONTEND: noninteractive
run: |
set -euo pipefail
apt-get install -y pgadmin4-server
# The version proves what installed is this build rather than
# something the distribution happened to carry, and the file list
# proves the package actually delivered its payload.
dpkg-query -W -f '${Package} ${Version}\n' pgadmin4-server
# grep without -q, deliberately: -q exits on the first match, the
# command feeding it then dies of SIGPIPE, and pipefail turns that
# into a failed pipeline even though the match succeeded.
dpkg -L pgadmin4-server | grep '^/usr/pgadmin4/' >/dev/null || {
echo "pgadmin4-server installed no files under /usr/pgadmin4" >&2
exit 1; }
yum:
needs: check
runs-on: ubuntu-24.04
# The images default to sh, which has no pipefail, so every step that set
# it died on the first line. All of these carry bash.
defaults:
run:
shell: bash
strategy:
fail-fast: false
matrix:
include:
- { name: 'rhel-9', image: 'almalinux:9', family: 'redhat' }
- { name: 'rhel-10', image: 'almalinux:10', family: 'redhat' }
- { name: 'fedora-43', image: 'fedora:43', family: 'fedora' }
- { name: 'fedora-44', image: 'fedora:44', family: 'fedora' }
container: ${{ matrix.image }}
steps:
- name: Follow the README
env:
BASE_URL: ${{ inputs.base-url }}
FAMILY: ${{ matrix.family }}
run: |
set -euo pipefail
# The repository RPM carries the .repo file and the packaging key, and
# points at the tree it shipped in, so nothing here names a URL twice.
# It sets gpgcheck=1 and repo_gpgcheck=1, which is why no --nogpgcheck
# appears below: a wrongly signed repository fails at this step.
RPM=$(curl -fsS "${BASE_URL}/yum/" \
| grep -oE "pgadmin4-${FAMILY}-repo-[0-9.-]+\.noarch\.rpm" \
| sort -u | tail -1)
echo "Repository package: ${RPM}"
rpm -i "${BASE_URL}/yum/${RPM}"
cat /etc/yum.repos.d/pgadmin4.repo
- name: Install pgAdmin
run: |
set -euo pipefail
dnf install -y pgadmin4-server
rpm -q pgadmin4-server
# grep without -q, deliberately: -q exits on the first match, the
# command feeding it then dies of SIGPIPE, and pipefail turns that
# into a failed pipeline even though the match succeeded.
rpm -ql pgadmin4-server | grep '^/usr/pgadmin4/' >/dev/null || {
echo "pgadmin4-server installed no files under /usr/pgadmin4" >&2
exit 1; }
# The Windows installer, actually installed. Nothing else in the pipeline
# runs it, and until now nothing verified the signature on the executable
# inside it either: Make.bat's own check tested a stale %ERRORLEVEL%, and the
# workflow step that claimed to cover the gap only re-verified the installer.
windows:
needs: check
runs-on: windows-2025
steps:
- name: Download and install
shell: pwsh
env:
BASE_URL: ${{ inputs.base-url }}
run: |
$ErrorActionPreference = 'Stop'
$listing = Invoke-WebRequest -Uri "$env:BASE_URL/" -UseBasicParsing
$name = ([regex]'pgadmin4-[0-9.]+-x64\.exe').Matches($listing.Content) |
ForEach-Object { $_.Value } | Sort-Object -Unique | Select-Object -Last 1
if (-not $name) { throw "No installer found at $env:BASE_URL" }
Write-Output "Installer: $name"
Invoke-WebRequest -Uri "$env:BASE_URL/$name" -OutFile installer.exe -UseBasicParsing
# The installer's own signature, before running anything from it.
$sig = Get-AuthenticodeSignature installer.exe
Write-Output "Installer signature: $($sig.Status) / $($sig.SignerCertificate.Subject)"
if ($sig.Status -ne 'Valid') { throw "Installer signature is $($sig.Status)" }
# Inno Setup's silent switches. /DIR is given so the check below does
# not depend on the default install location.
$p = Start-Process -FilePath .\installer.exe -Wait -PassThru `
-ArgumentList '/VERYSILENT','/SUPPRESSMSGBOXES','/NORESTART','/DIR=C:\pgadmin4-test'
if ($p.ExitCode -ne 0) { throw "Installer exited with $($p.ExitCode)" }
- name: Check what was installed
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$root = 'C:\pgadmin4-test'
# The components that carry no signature of ours, and so are only
# checked for presence. Everything we do sign is covered by the step
# below, which checks that it is there as a side effect of verifying
# it.
foreach ($f in @("$root\python\python.exe", "$root\web\pgAdmin4.py")) {
if (-not (Test-Path $f)) { throw "Missing from the installation: $f" }
Write-Output "present: $f"
}
# Everything Make.bat's :SIGN_COMPONENTS signs, verified where it lands.
# None of it exists outside the installer until the installer has run, so
# this is the only place a published build can be checked: the runtime
# executable, and the PostgreSQL and Kerberos binaries we ship alongside
# it. The Electron, Python and VC++ runtime components are deliberately
# not signed by us and so are not listed here.
- name: Check the component signatures
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$root = 'C:\pgadmin4-test'
# The publisher is taken from the installer rather than hard coded,
# so that a component signed by somebody else is caught without this
# needing an edit every time the certificate is renewed.
$expected = (Get-AuthenticodeSignature installer.exe).SignerCertificate.Subject
Write-Output "Expected publisher: $expected"
# winpgbuild does not always ship these four, and Make.bat copies them
# only when they are present, so an empty match is not a failure.
$optional = @('libintl-*.dll', 'libiconv-*.dll', 'liblz4.dll', 'libzstd.dll')
foreach ($pattern in @(
'pgAdmin4.exe',
'libpq.dll', 'libcrypto-*-x64.dll', 'libssl-*-x64.dll', 'zlib1.dll',
'pg_dump.exe', 'pg_dumpall.exe', 'pg_restore.exe', 'psql.exe',
'kinit.exe', 'krb5_64.dll', 'comerr64.dll', 'k5sprt64.dll',
'gssapi64.dll', 'krbcc64.dll', 'ccapiserver.exe') + $optional) {
$files = @(Get-ChildItem -Path "$root\runtime\$pattern" -ErrorAction SilentlyContinue)
if ($files.Count -eq 0) {
if ($optional -contains $pattern) {
Write-Output "absent, and optional: $pattern"
continue
}
throw "Missing from the installation: $root\runtime\$pattern"
}
foreach ($f in $files) {
$sig = Get-AuthenticodeSignature $f.FullName
Write-Output "$($f.Name): $($sig.Status) / $($sig.SignerCertificate.Subject)"
if ($sig.Status -ne 'Valid') {
throw "$($f.Name) signature is $($sig.Status)"
}
if ($sig.SignerCertificate.Subject -ne $expected) {
throw "$($f.Name) was signed by $($sig.SignerCertificate.Subject)"
}
}
}
# The macOS disk image as published, rather than the bundle as built. The
# snapshot workflow checks the bundle it has just made; this checks what a
# user downloads, which has been through a DMG, a web server and a browser's
# quarantine attribute.
macos:
needs: check
runs-on: ${{ matrix.runner }}
strategy:
fail-fast: false
matrix:
include:
- { name: 'arm64', runner: 'macos-15' }
- { name: 'x64', runner: 'macos-26-intel' }
steps:
- name: Download, mount and check
env:
BASE_URL: ${{ inputs.base-url }}
ARCH: ${{ matrix.name }}
run: |
set -euo pipefail
name=$(curl -fsS "${BASE_URL}/" \
| grep -oE "pgadmin4-[0-9.]+-${ARCH}\.dmg" | sort -u | tail -1)
[ -n "${name}" ] || { echo "No ${ARCH} disk image found" >&2; exit 1; }
echo "Disk image: ${name}"
curl -fsS -o image.dmg "${BASE_URL}/${name}"
# Quarantine it as a browser would, so Gatekeeper is actually
# consulted rather than bypassed because the file arrived by curl.
xattr -w com.apple.quarantine \
"0081;$(printf '%x' "$(date +%s)");Safari;" image.dmg
hdiutil attach image.dmg -nobrowse -readonly -mountpoint /tmp/pga
app="/tmp/pga/pgAdmin 4.app"
test -d "${app}"
test -x "${app}/Contents/MacOS/pgAdmin 4"
test -x "${app}/Contents/SharedSupport/pg_dump"
test -f "${app}/Contents/Resources/web/pgAdmin4.py"
# Gatekeeper first, because that is what decides whether a user can
# open this. codesign --strict comes after and is allowed to have its
# own opinion: the disk image deliberately carries a FinderInfo xattr
# on the bundle, set by SetFile -a E in _create_dmg to hide the .app
# extension in the window, and --strict rejects any xattr at all.
echo "=== notarisation and Gatekeeper ==="
# stapler looks the ticket up in Apple's CloudKit, and a dropped
# connection there fails the step with error 68, so it is retried.
# A genuinely broken ticket still fails all three attempts.
for attempt in 1 2 3; do
xcrun stapler validate "${app}" && break
[ "${attempt}" -lt 3 ] || exit 1
echo "stapler validate failed; retrying in $((attempt * 30))s"
sleep $((attempt * 30))
done
spctl --assess --type execute --verbose=4 "${app}"
echo "=== signature ==="
codesign -dvvv "${app}" 2>&1 | grep -E 'Authority|TeamIdentifier'
codesign --verify --deep --verbose=2 "${app}"
# Reported rather than enforced. If this ever starts failing whilst
# spctl still passes, it is the extension-hiding attribute and not a
# broken signature; if spctl fails too, the build is broken.
if ! codesign --verify --deep --strict --verbose=2 "${app}" 2>/tmp/strict.log; then
echo "note: --strict verification failed, Gatekeeper having passed:"
tail -2 /tmp/strict.log
fi
# Nothing in the bundle may reference a build machine. This is what
# catches a dependency that was linked but not relocated, which is
# how an ICU or OpenSSL path would escape.
echo "=== linkage of the bundled client binaries ==="
for b in pg_dump pg_dumpall pg_restore psql; do
echo "--- ${b} ---"
otool -L "${app}/Contents/SharedSupport/${b}" | tail -n +2
done
if otool -L "${app}/Contents/SharedSupport/"* \
| grep -E '/opt/pgbuild|/opt/homebrew|/usr/local/(lib|opt)'; then
echo "A bundled binary still points outside the bundle" >&2
exit 1
fi
hdiutil detach /tmp/pga
# The downloads nobody installs: the wheel, the tarballs and the documents.
# Shallow by design, but it does verify every detached signature from the
# published URL rather than on the server, which is what a user would get.
artefacts:
needs: check
runs-on: ubuntu-24.04
steps:
- name: Fetch and check
env:
BASE_URL: ${{ inputs.base-url }}
run: |
set -euo pipefail
mkdir -p dl && cd dl
listing=$(curl -fsS "${BASE_URL}/")
fetch() {
local pattern=$1 name
name=$(printf '%s' "${listing}" | grep -oE "${pattern}" | sort -u | tail -1)
[ -n "${name}" ] || { echo "Nothing matching ${pattern}" >&2; exit 1; }
curl -fsS -O "${BASE_URL}/${name}"
echo "${name}"
}
tarball=$(fetch 'pgadmin4-[0-9.]+\.tar\.gz')
wheel=$(fetch 'pgadmin4-[0-9.]+-py3-none-any\.whl')
docs=$(fetch 'pgadmin4-[0-9.]+-docs\.tar\.gz')
pdf=$(fetch 'pgadmin4-[0-9.]+\.pdf')
epub=$(fetch 'pgadmin4-[0-9.]+\.epub')
echo "=== signatures, as a user would verify them ==="
export GNUPGHOME=$(mktemp -d); chmod 700 "${GNUPGHOME}"
curl -fsS https://www.pgadmin.org/static/packages_pgadmin_org.pub | gpg --import
for f in "${tarball}" "${wheel}" "${docs}" "${pdf}" "${epub}"; do
curl -fsS -O "${BASE_URL}/${f}.asc"
gpg --verify "${f}.asc" "${f}"
done
echo "=== the documents are what they claim to be ==="
file "${pdf}" | grep -q 'PDF document'
file "${epub}" | grep -q 'EPUB'
# A truncated PDF still says PDF, so size is checked too.
[ "$(stat -c%s "${pdf}")" -gt 1000000 ] || { echo "PDF is implausibly small" >&2; exit 1; }
echo "=== the tarballs contain what they should ==="
tar tzf "${tarball}" | grep -E '/web/pgAdmin4\.py$' >/dev/null
tar tzf "${tarball}" | grep -E '/requirements\.txt$' >/dev/null
tar tzf "${docs}" | grep -E 'index\.html$' >/dev/null
- name: Install the wheel
run: |
set -euo pipefail
cd dl
python3 -m venv /tmp/wheeltest
/tmp/wheeltest/bin/pip install --quiet pgadmin4-*-py3-none-any.whl
/tmp/wheeltest/bin/python -c 'import pgadmin4; print("imported", pgadmin4.__file__)'
+151 -4
View File
@@ -1,28 +1,175 @@
name: Check container build
on:
# Callable, so that a workflow which needs a container build gets this one
# rather than a second definition of it that can drift. Snapshot does not
# call it today, the image not being part of the download tree.
workflow_call:
inputs:
publish:
description: >-
Build for both architectures and push to the registry, tagged
with the location below. A build check does neither: it proves
the Dockerfile still works and throws the image away.
type: boolean
required: false
default: false
location:
description: The tag to push, normally the build's date
type: string
required: false
default: ''
secrets:
DOCKERHUB_USERNAME:
required: false
DOCKERHUB_TOKEN:
required: false
push:
branches: [ "master" ]
paths:
- 'Dockerfile'
- 'pkg/docker/**'
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'docs/**'
- '.dockerignore'
- 'LICENSE'
- '.github/workflows/check-container-build.yml'
pull_request:
branches: [ "master" ]
paths:
- 'Dockerfile'
- 'pkg/docker/**'
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'docs/**'
- '.dockerignore'
- 'LICENSE'
- '.github/workflows/check-container-build.yml'
workflow_dispatch:
inputs:
publish:
description: Build for both architectures and push to the registries
type: boolean
required: false
default: false
location:
description: The tag to push, normally the build's date
type: string
required: false
default: ''
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
# github.event_name is in the key because a called workflow inherits the
# caller's ref: once this is on master, the nightly Snapshot's deb build
# and an ordinary push's deb build would otherwise share a group and,
# with cancel-in-progress, kill each other. A push landing mid-nightly
# would cancel the snapshot's build and skip the publish entirely.
group: 'check-container-build @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }} @ ${{ github.event_name }}'
cancel-in-progress: true
# Read-only by default, as everywhere else here. The publish job below names
# the wider set it genuinely needs, and a job-level block replaces this one
# rather than adding to it, so its packages: write is unaffected.
permissions:
contents: read
jobs:
# The check. No environment, and so no access to the registry credentials:
# this runs on every pull request, and a build check has no business being
# able to push anything.
build-container:
if: ${{ !inputs.publish }}
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
with:
fetch-depth: 2
- name: Build the container
uses: docker/build-push-action@v6
- name: Check the container builds
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
with:
push: false
context: .
# The publish. Declared on the publishing environment, which is where the
# Docker Hub credentials live: an environment secret is not available to a
# job that does not name the environment, which is what secrets: inherit
# alone does not solve.
publish-container:
if: inputs.publish
runs-on: ubuntu-22.04
environment: publishing
permissions:
contents: read
# For GHCR, which takes the workflow's own token rather than a stored
# registry credential.
packages: write
steps:
# Before anything is logged in to, because this value becomes a tag in
# a job holding the Docker Hub credentials, and the tags input is
# newline separated: an unchecked value could name a second tag, and a
# tag can name another repository. The shape is the one the wrapper
# requires of a build location.
- name: Check the location
env:
LOCATION: ${{ inputs.location }}
run: |
set -euo pipefail
printf '%s' "${LOCATION}" \
| grep -Eq '^[0-9]{4}-[0-9]{2}-[0-9]{2}(-([1-9][0-9]?|[A-Za-z][A-Za-z0-9]*))?$' || {
echo "Not a build location: ${LOCATION}" >&2; exit 1; }
- uses: actions/checkout@v7
with:
fetch-depth: 2
# Emulation is slow, so only the publishing path pays for it.
- name: Set up QEMU
uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3
- name: Set up Buildx
uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3
- name: Log in to Docker Hub
uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Log in to GHCR
uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
# Tagged with the build's location rather than a version. Promotion
# re-tags this exact image, so what ships is the manifest that was
# tested rather than a rebuild of the same source.
- name: Build and push the container
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
with:
push: true
context: .
platforms: linux/amd64,linux/arm64
tags: |
dpage/pgadmin4:${{ inputs.location }}
ghcr.io/pgadmin-org/pgadmin4:${{ inputs.location }}
+140
View File
@@ -0,0 +1,140 @@
# Replaces the pgadmin4-deb-qa Jenkins job. That job runs `make debian` on a
# dedicated EC2 VM per distribution; here each distribution is a container on a
# hosted runner instead, which is the same build in a reproducible environment
# and no VMs to maintain.
#
# Triggered on master and by hand rather than on pull requests, matching what
# the Jenkins job does today (it polls git every five minutes). Running the
# full matrix on every PR is a separate decision.
name: Check DEB builds
on:
# Callable from snapshot.yml, so that what gets published is the
# same build that runs on every push rather than a second
# definition of it that can drift.
workflow_call:
push:
branches: [ "master" ]
paths:
- 'pkg/debian/**'
- 'pkg/linux/**'
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'docs/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-deb-build.yml'
workflow_dispatch:
concurrency:
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
# github.event_name is in the key because a called workflow inherits the
# caller's ref: once this is on master, the nightly Snapshot's deb build
# and an ordinary push's deb build would otherwise share a group and,
# with cancel-in-progress, kill each other. A push landing mid-nightly
# would cancel the snapshot's build and skip the publish entirely.
group: 'check-deb-build @ ${{ github.ref }} @ ${{ github.event_name }}'
cancel-in-progress: true
permissions:
contents: read
jobs:
build-deb:
runs-on: ubuntu-24.04
strategy:
fail-fast: false
matrix:
include:
# "name" exists only because artifact names may not contain a colon.
- { name: 'debian-12', image: 'debian:12' }
- { name: 'debian-13', image: 'debian:13' }
- { name: 'ubuntu-2204', image: 'ubuntu:22.04' }
- { name: 'ubuntu-2404', image: 'ubuntu:24.04' }
- { name: 'ubuntu-2604', image: 'ubuntu:26.04' }
container: ${{ matrix.image }}
steps:
# Before checkout, so the action has git available and the container has
# the certificates it needs to fetch anything.
- name: Install the build environment
env:
DEBIAN_FRONTEND: noninteractive
run: |
apt-get update
apt-get install -y --no-install-recommends \
build-essential \
ca-certificates \
curl \
dh-exec \
dpkg-dev \
fakeroot \
git \
libffi-dev \
libkrb5-dev \
libpq-dev \
libreadline-dev \
libssl-dev \
lsb-release \
python3-dev \
python3-pip \
python3-sphinx \
python3-venv \
python3-wheel \
unzip \
wget \
zlib1g-dev
# sphinxcontrib-youtube has no distro package. --break-system-packages is
# needed from Debian 12 and Ubuntu 24.04 onwards (PEP 668), and is
# harmless before that, but the flag itself only exists on newer pip, so
# fall back rather than fail.
- name: Install the Sphinx extensions
run: |
python3 -m pip install --break-system-packages sphinxcontrib-youtube \
|| python3 -m pip install sphinxcontrib-youtube
- name: Install syft
run: curl -sSfL https://raw.githubusercontent.com/anchore/syft/v1.52.0/install.sh | sh -s -- -b /usr/local/bin v1.52.0
- uses: actions/setup-node@v7
with:
node-version: '20.x'
- uses: actions/checkout@v7
# The container runs as root while the workspace is owned by the runner
# user, so git refuses to operate on it ("detected dubious ownership").
# The build shells out to git for the commit hash during `yarn run
# bundle`, which fails with exit 128 without this.
- name: Mark the workspace as a safe git directory
run: git config --global --add safe.directory "${GITHUB_WORKSPACE}"
# Corepack provisions the pinned Yarn from the packageManager field,
# matching run-javascript-tests.yml. The distro nodejs packages are
# avoided entirely: on Ubuntu 26.04 the distro node ships without npm,
# which is why the buildfarm has to pin NodeSource above it.
- name: Enable Corepack
run: corepack enable
- name: Check the DEB build
run: make debian
- name: Archive the packages
uses: actions/upload-artifact@v7
with:
name: pgadmin4-deb-build-output-${{ matrix.name }}
if-no-files-found: error
path: dist/*.deb
+40 -5
View File
@@ -1,15 +1,47 @@
name: Check documentation builds
on:
# Callable from snapshot.yml, so that what gets published is the
# same build that runs on every push rather than a second
# definition of it that can drift.
workflow_call:
push:
branches: [ "master" ]
paths:
- 'docs/**'
- 'web/version.py'
- 'web/branding.py'
- 'requirements.txt'
- 'Makefile'
- 'web/config.py'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-doc-builds.yml'
pull_request:
branches: [ "master" ]
paths:
- 'docs/**'
- 'web/version.py'
- 'web/branding.py'
- 'requirements.txt'
- 'Makefile'
- 'web/config.py'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-doc-builds.yml'
workflow_dispatch:
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
# github.event_name is in the key because a called workflow inherits the
# caller's ref: once this is on master, the nightly Snapshot's deb build
# and an ordinary push's deb build would otherwise share a group and,
# with cancel-in-progress, kill each other. A push landing mid-nightly
# would cancel the snapshot's build and skip the publish entirely.
group: 'check-doc-builds @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }} @ ${{ github.event_name }}'
cancel-in-progress: true
jobs:
@@ -17,7 +49,7 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Install platform dependencies
run: |
@@ -33,9 +65,10 @@ jobs:
make docs
- name: Archive HTML
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: pgadmin4-html-build-output
if-no-files-found: error
path: docs/en_US/_build/html/*
- name: Check the ePub build
@@ -44,9 +77,10 @@ jobs:
make docs-epub
- name: Archive ePub
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: pgadmin4-epub-build-output
if-no-files-found: error
path: docs/en_US/_build/epub/pgAdmin4.epub
- name: Check the PDF build
@@ -55,7 +89,8 @@ jobs:
make docs-pdf
- name: Archive PDF
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: pgadmin4-pdf-build-output
if-no-files-found: error
path: docs/en_US/_build/latex/pgadmin4.pdf
+59
View File
@@ -0,0 +1,59 @@
# Replaces the pgadmin4-helm-buildx-qa Jenkins job, which runs
# `helm package pkg/helm` and nothing else. Helm is installed explicitly rather
# than relied upon from the runner image, since what the images ship changes
# between versions.
name: Check Helm chart build
on:
# Callable from snapshot.yml, so that what gets published is the
# same build that runs on every push rather than a second
# definition of it that can drift.
workflow_call:
push:
branches: [ "master" ]
paths:
- 'pkg/helm/**'
- '.github/workflows/check-helm-build.yml'
workflow_dispatch:
concurrency:
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
# github.event_name is in the key because a called workflow inherits the
# caller's ref: once this is on master, the nightly Snapshot's deb build
# and an ordinary push's deb build would otherwise share a group and,
# with cancel-in-progress, kill each other. A push landing mid-nightly
# would cancel the snapshot's build and skip the publish entirely.
group: 'check-helm-build @ ${{ github.ref }} @ ${{ github.event_name }}'
cancel-in-progress: true
permissions:
contents: read
jobs:
build-chart:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v7
- name: Install Helm
run: |
curl -fsSL https://raw.githubusercontent.com/helm/helm/v4.3.0/scripts/get-helm-3 -o get-helm-3
chmod 700 get-helm-3
./get-helm-3
- name: Check the chart build
run: helm package pkg/helm
- name: Archive the chart
uses: actions/upload-artifact@v7
with:
name: pgadmin4-helm-build-output
if-no-files-found: error
path: pgadmin4-helm-*.tgz
+23 -6
View File
@@ -3,8 +3,24 @@ name: Check Javascript style
on:
push:
branches: [ "master" ]
paths:
- 'web/**/*.js'
- 'web/**/*.jsx'
- 'web/package.json'
- 'web/yarn.lock'
- 'web/.eslintrc.js'
- 'web/.yarnrc.yml'
- '.github/workflows/check-javascript-style.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**/*.js'
- 'web/**/*.jsx'
- 'web/package.json'
- 'web/yarn.lock'
- 'web/.eslintrc.js'
- 'web/.yarnrc.yml'
- '.github/workflows/check-javascript-style.yml'
workflow_dispatch:
@@ -17,17 +33,18 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Upgrade yarn
run: |
yarn set version berry
yarn set version 4
# Corepack reads packageManager from web/package.json and provisions
# exactly that Yarn: a single pinned download, with nothing written
# into the checkout.
- name: Enable Corepack
run: corepack enable
- name: Install Node modules
run: |
cd web
yarn install
yarn install --immutable
- name: Run the linter
run: |
+126
View File
@@ -0,0 +1,126 @@
# Replaces the pgadmin4-macos-qa Jenkins job. That job runs `make appbundle` on
# the two EC2 Mac workers; this runs the same build on hosted runners, which
# cover both architectures.
#
# The build is unsigned and unnotarised: pkg/mac/build.sh sets CODESIGN=0 and
# NOTARIZE=0 when pkg/mac/codesign.conf and pkg/mac/notarization.conf are
# absent, so this needs no secrets. Signing belongs to the release and snapshot
# builds.
#
# PostgreSQL comes from Homebrew for pg_config (psycopg builds against it) and
# for the four client binaries copied into the bundle. The release build uses
# a PostgreSQL built against its own OpenSSL and Kerberos; that difference
# does not matter for a build check, and _fixup_imports relocates Homebrew's
# libraries into the bundle correctly (verified by _verify_bundle_linkage,
# which fails the build if anything still points outside it).
name: Check macOS builds
on:
push:
branches: [ "master" ]
paths:
- 'pkg/mac/**'
- '.github/actions/install-pgbuild-deps/action.yml'
# Which build of each dependency this compiles against, so a
# change to it changes what the installer contains.
- 'pkg/pgbuild-deps.lock'
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'docs/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-macos-build.yml'
workflow_dispatch:
concurrency:
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
group: 'check-macos-build @ ${{ github.ref }}'
cancel-in-progress: true
permissions:
contents: read
jobs:
build-appbundle:
runs-on: ${{ matrix.runner }}
strategy:
fail-fast: false
matrix:
include:
# "arch" is pgbuild's spelling of the architecture, which differs
# from the one this build uses internally (x64 rather than x86_64).
- { name: 'arm64', arch: 'arm64', runner: 'macos-15' }
# macos-26-intel rather than macos-15-intel: create-dmg's unmount
# scales with how much real Mach-O content lands on the volume, and
# the macos-15-intel image is slow enough that the real bundle
# crosses hdiutil's 120-second DiskArbitration timeout. Measured with
# an identical payload, unmount to "Disk image done": 19s on arm64,
# 41s on macos-26-intel, 82s on macos-15-intel, and that was with a
# lighter stand-in than the real bundle. It is also the newer image,
# which we would move to regardless since macOS 15 retires first.
- { name: 'x64', arch: 'x86_64', runner: 'macos-26-intel' }
timeout-minutes: 120
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v7
with:
node-version: '20.x'
- name: Enable Corepack
run: corepack enable
# syft generates the SBOM, wget fetches Electron. PostgreSQL and its
# dependencies no longer come from Homebrew; see below.
- name: Install the build dependencies
run: brew install syft wget
# The dependencies come from pgadmin-org/pgbuild, built against each
# other with --with-zstd --with-lz4 and a 14.0 deployment target, which
# is what the release build ships. Homebrew's PostgreSQL was only ever a
# stand-in: it has no zstd or lz4 support (issue #9425), links Homebrew's
# OpenSSL rather than ours, and carries whatever minimum OS Homebrew
# happened to build for.
- name: Install the PostgreSQL build dependencies
uses: ./.github/actions/install-pgbuild-deps
with:
arch: ${{ matrix.arch }}
- name: Show what pg_dump expects
run: otool -L /opt/pgbuild/postgresql/bin/pg_dump
- name: Check the appbundle build
run: |
export PGADMIN_POSTGRES_DIR=/opt/pgbuild/postgresql
# cryptography publishes arm64-only macOS wheels (checked against
# 50.0.1), so on Intel pip builds it from the sdist and its
# openssl-sys crate links whatever OpenSSL it finds on the build
# host. _fixup_imports deliberately skips _rust.abi3.so, so that
# reference would survive into the bundle and _verify_bundle_linkage
# would fail the build. Linking statically leaves no external
# reference at all, and against our own OpenSSL rather than a
# different one from Homebrew. See issue #10123.
export OPENSSL_DIR=/opt/pgbuild/openssl
export OPENSSL_STATIC=1
make appbundle
- name: Archive the disk image
uses: actions/upload-artifact@v7
with:
name: pgadmin4-macos-build-output-${{ matrix.name }}
if-no-files-found: error
path: dist/*.dmg
+46 -3
View File
@@ -1,15 +1,57 @@
name: Check Python build
on:
# Callable from snapshot.yml, so that what gets published is the
# same build that runs on every push rather than a second
# definition of it that can drift.
workflow_call:
push:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'pkg/pip/**'
- 'requirements.txt'
- 'Makefile'
- 'docs/**'
- 'LICENSE'
- 'README.md'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-python-build.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'pkg/pip/**'
- 'requirements.txt'
- 'Makefile'
- 'docs/**'
- 'LICENSE'
- 'README.md'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-python-build.yml'
workflow_dispatch:
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
# github.event_name is in the key because a called workflow inherits the
# caller's ref: once this is on master, the nightly Snapshot's deb build
# and an ordinary push's deb build would otherwise share a group and,
# with cancel-in-progress, kill each other. A push landing mid-nightly
# would cancel the snapshot's build and skip the publish entirely.
group: 'check-python-build @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }} @ ${{ github.event_name }}'
cancel-in-progress: true
jobs:
@@ -17,7 +59,7 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Install platform dependencies
run: |
@@ -33,7 +75,8 @@ jobs:
make pip
- name: Archive Python wheel
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: pgadmin4-python-build-output
if-no-files-found: error
path: dist/*
+9 -1
View File
@@ -3,8 +3,16 @@ name: Check Python style
on:
push:
branches: [ "master" ]
paths:
- '**.py'
- '.pycodestyle'
- '.github/workflows/check-python-style.yml'
pull_request:
branches: [ "master" ]
paths:
- '**.py'
- '.pycodestyle'
- '.github/workflows/check-python-style.yml'
workflow_dispatch:
@@ -17,7 +25,7 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Install Python dependencies
run: |
+173
View File
@@ -0,0 +1,173 @@
# Replaces the pgadmin4-rpm-qa Jenkins job, as check-deb-build.yml replaces the
# DEB one: a container per distribution on a hosted runner, rather than a
# dedicated EC2 VM per distribution.
#
# Unlike the DEB build, the PGDG repository is not optional here.
# pkg/redhat/build.sh opens with `export PATH=$(ls -d /usr/pgsql-1* | ...)` and
# runs under `set -e`, so the build dies immediately without a PGDG PostgreSQL
# installed.
#
# The QA job does not sign anything; `rpmsign --resign` is a separate step in
# the release and snapshot jobs.
name: Check RPM builds
on:
# Callable from snapshot.yml, so that what gets published is the
# same build that runs on every push rather than a second
# definition of it that can drift.
workflow_call:
push:
branches: [ "master" ]
paths:
- 'pkg/redhat/**'
- 'pkg/linux/**'
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'docs/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-rpm-build.yml'
workflow_dispatch:
concurrency:
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
# github.event_name is in the key because a called workflow inherits the
# caller's ref: once this is on master, the nightly Snapshot's deb build
# and an ordinary push's deb build would otherwise share a group and,
# with cancel-in-progress, kill each other. A push landing mid-nightly
# would cancel the snapshot's build and skip the publish entirely.
group: 'check-rpm-build @ ${{ github.ref }} @ ${{ github.event_name }}'
cancel-in-progress: true
permissions:
contents: read
jobs:
build-rpm:
runs-on: ubuntu-24.04
strategy:
fail-fast: false
matrix:
include:
# "name" exists only because artifact names may not contain a colon.
# "repo" selects the PGDG repository RPM, which is built per
# distribution family and major version.
- name: 'el-9'
image: 'almalinux:9'
repo: 'https://download.postgresql.org/pub/repos/yum/reporpms/EL-9-x86_64/pgdg-redhat-repo-latest.noarch.rpm'
- name: 'el-10'
image: 'almalinux:10'
repo: 'https://download.postgresql.org/pub/repos/yum/reporpms/EL-10-x86_64/pgdg-redhat-repo-latest.noarch.rpm'
- name: 'fedora-43'
image: 'fedora:43'
repo: 'https://download.postgresql.org/pub/repos/yum/reporpms/F-43-x86_64/pgdg-fedora-repo-latest.noarch.rpm'
- name: 'fedora-44'
image: 'fedora:44'
repo: 'https://download.postgresql.org/pub/repos/yum/reporpms/F-44-x86_64/pgdg-fedora-repo-latest.noarch.rpm'
container: ${{ matrix.image }}
steps:
# Before checkout, so the action has git available.
- name: Install the build environment
env:
PGDG_REPO: ${{ matrix.repo }}
run: |
dnf install -y dnf-plugins-core
# EL needs EPEL and CRB for the build dependencies; Fedora has
# everything in the main repositories.
if [ ! -f /etc/fedora-release ]; then
dnf install -y epel-release
dnf config-manager --set-enabled crb
fi
# The distro's own PostgreSQL module would shadow PGDG's packages.
dnf -qy module disable postgresql || true
dnf install -y --nogpgcheck "${PGDG_REPO}"
# The compiler toolchain is not optional: psycopg-c and gssapi are
# both built from source (pkg/linux/build-functions.sh passes
# --no-binary psycopg), and rpmbuild needs redhat-rpm-config. The
# buildfarm gets these from the @development-tools group; they are
# listed individually here so the container stays small.
dnf install -y \
diffutils \
expect \
fakeroot \
file \
findutils \
gcc \
gcc-c++ \
git \
krb5-devel \
libpq5-devel \
make \
openssl-devel \
patch \
postgresql18-devel \
python3-devel \
python3-pip \
python3-sphinx \
redhat-rpm-config \
rpm-build \
rpm-sign \
unzip \
wget \
yum-utils \
zlib-devel
# pkg/redhat/build.sh:229 shells out to yumdownloader, and a missing
# one surfaces as a bare exit 127 twelve minutes into the build,
# after the docs and the webpack bundle. Fail here instead, where the
# message is obvious. dnf5 distributions (EL10, Fedora 41+) get
# yumdownloader through yum-utils' compatibility shims rather than
# from yum itself, so it is worth checking rather than assuming.
command -v yumdownloader >/dev/null || {
echo "ERROR: yumdownloader is not on PATH; pkg/redhat/build.sh needs it." >&2
exit 1
}
- name: Install the Sphinx extensions
run: python3 -m pip install --break-system-packages sphinxcontrib-youtube || python3 -m pip install sphinxcontrib-youtube
- name: Install syft
run: curl -sSfL https://raw.githubusercontent.com/anchore/syft/v1.52.0/install.sh | sh -s -- -b /usr/local/bin v1.52.0
- uses: actions/setup-node@v7
with:
node-version: '20.x'
- uses: actions/checkout@v7
# The container runs as root while the workspace is owned by the runner
# user, so git refuses to operate on it ("detected dubious ownership").
# The build shells out to git for the commit hash during `yarn run
# bundle`, which fails with exit 128 without this.
- name: Mark the workspace as a safe git directory
run: git config --global --add safe.directory "${GITHUB_WORKSPACE}"
- name: Enable Corepack
run: corepack enable
- name: Check the RPM build
run: make redhat
- name: Archive the packages
uses: actions/upload-artifact@v7
with:
name: pgadmin4-rpm-build-output-${{ matrix.name }}
if-no-files-found: error
path: dist/*.rpm
+46 -3
View File
@@ -1,15 +1,57 @@
name: Check tarball build
on:
# Callable from snapshot.yml, so that what gets published is the
# same build that runs on every push rather than a second
# definition of it that can drift.
workflow_call:
push:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'docs/**'
- 'pkg/src/**'
- 'requirements.txt'
- 'Makefile'
- 'LICENSE'
- 'README.md'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-tarball-build.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'docs/**'
- 'pkg/src/**'
- 'requirements.txt'
- 'Makefile'
- 'LICENSE'
- 'README.md'
- 'tools/setup-python-env.sh'
- '.github/workflows/check-tarball-build.yml'
workflow_dispatch:
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
# github.event_name is in the key because a called workflow inherits the
# caller's ref: once this is on master, the nightly Snapshot's deb build
# and an ordinary push's deb build would otherwise share a group and,
# with cancel-in-progress, kill each other. A push landing mid-nightly
# would cancel the snapshot's build and skip the publish entirely.
group: 'check-tarball-build @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }} @ ${{ github.event_name }}'
cancel-in-progress: true
jobs:
@@ -17,7 +59,7 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Install platform dependencies
run: |
@@ -33,7 +75,8 @@ jobs:
make src
- name: Archive source tarball
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: pgadmin4-tarball-build-output
if-no-files-found: error
path: dist/*
+9 -1
View File
@@ -3,8 +3,16 @@ name: Check translations
on:
push:
branches: [ "master" ]
paths:
- 'web/**'
- 'Makefile'
- '.github/workflows/check-translations.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
- 'Makefile'
- '.github/workflows/check-translations.yml'
workflow_dispatch:
@@ -17,7 +25,7 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Install platform dependencies
run: |
+149
View File
@@ -0,0 +1,149 @@
# Replaces the pgadmin4-windows-x64-qa Jenkins job.
#
# This runs on a hosted runner, not a self-hosted one. Code signing in Make.bat
# is conditional on PGADMIN_WINDOWS_CSC being set (see :SIGN_FILES,
# :CREATE_INSTALLER and :VERIFY_SIGNATURE in Make.bat), so an unsigned build
# check needs neither the Certum hardware token nor the machine it is plugged
# into. Only the release and snapshot builds, which do sign, need the
# self-hosted runner.
#
# Dependencies come from dpage/winpgbuild, which is exactly where the
# buildfarm's winpgbuild-update job gets them, so the toolchain matches what
# the release build uses rather than being an approximation of it.
#
# UNTESTED as written: unlike the macOS equivalent this has not yet had a
# successful run, so expect the first few attempts to need adjustment.
name: Check Windows build
on:
push:
branches: [ "master" ]
paths:
- 'Make.bat'
- 'pkg/win32/**'
- 'pkg/python-version.txt'
- '.github/actions/install-pgbuild-deps/action.yml'
# Which build of each dependency this compiles against, so a
# change to it changes what the installer contains.
- 'pkg/pgbuild-deps.lock'
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'docs/**'
- 'requirements.txt'
- '.github/workflows/check-windows-build.yml'
workflow_dispatch:
concurrency:
# The workflow's own name, spelled out rather than taken from
# github.workflow, because in a reusable workflow that expression is
# the CALLER's name. Every workflow Snapshot calls would otherwise
# share one group and, with cancel-in-progress, cancel each other.
group: 'check-windows-build @ ${{ github.ref }}'
cancel-in-progress: true
permissions:
contents: read
jobs:
build-installer:
runs-on: windows-2025
timeout-minutes: 120
env:
# The major version of the PostgreSQL release to pull from pgbuild,
# matching DEFAULT_POSTGRESQL_VERSION on the buildfarm.
POSTGRES_MAJOR: '18'
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v7
with:
node-version: '20.x'
- name: Enable Corepack
run: corepack enable
# None of these are on the hosted image. wget matters most: Make.bat's
# Electron download is an unbounded retry loop (Make.bat:370), so without
# it the build spins on error 9009 until the job times out rather than
# failing. syft generates the SBOM, and its absence is silent, since
# :GENERATE_SBOM redirects into sbom.json and returns 0 regardless. The
# buildfarm's Windows worker installs all three via Chocolatey too.
- name: Install Inno Setup, syft and wget
run: choco install innosetup syft wget -y --no-progress
# From pgadmin-org/pgbuild, which supersedes dpage/winpgbuild and is
# where the macOS dependencies come from too, so both platforms build
# against one manifest of pinned versions. The archives unpack to
# <DEPS_DIR>\postgresql and <DEPS_DIR>\krb5.
# Unpacked under the runner's own temp directory rather than a fixed
# path. C:\build64 was the obvious choice and the wrong one: it is what
# the buildfarm's winpgbuild-update job manages on the Windows worker,
# deleting and re-extracting postgresql and krb5 inside it. Since the
# signing builds will run on that same machine as a self-hosted runner,
# a shared path would have the two systems overwriting each other's
# dependencies, and the resulting Jenkins failures would look nothing
# like their cause.
- name: Install the PostgreSQL and Kerberos dependencies
id: deps
uses: ./.github/actions/install-pgbuild-deps
with:
arch: x86_64
postgres-major: ${{ env.POSTGRES_MAJOR }}
- name: Record the dependency location
shell: pwsh
run: '"DEPS_DIR=${{ steps.deps.outputs.prefix }}" | Out-File -FilePath $env:GITHUB_ENV -Append'
# The hosted image ships Visual Studio Enterprise at a path that differs
# from the Community install Make.bat defaults to, and the redistributable
# version directory changes with every VS update, so both are discovered
# rather than hardcoded.
- name: Locate the Visual Studio toolchain
shell: pwsh
run: |
$vswhere = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe"
$vs = & $vswhere -latest -products * -property installationPath
if (-not $vs) { throw "Could not locate a Visual Studio installation" }
Write-Output "Visual Studio: $vs"
$redist = Get-ChildItem "$vs\VC\Redist\MSVC" -Directory |
Where-Object { Test-Path "$($_.FullName)\vc_redist.x64.exe" } |
Sort-Object Name -Descending |
Select-Object -First 1
if (-not $redist) { throw "Could not locate vc_redist.x64.exe under $vs" }
Write-Output "VC++ redistributable: $($redist.FullName)"
"VS_INSTALL_DIR=$vs" | Out-File -FilePath $env:GITHUB_ENV -Append
"PGADMIN_VCREDIST_DIR=$($redist.FullName)" | Out-File -FilePath $env:GITHUB_ENV -Append
# psycopg[c] compiles against libpq, so the build needs the MSVC
# environment. vcvars64.bat only sets it for its own process, hence
# invoking it and Make.bat in a single cmd session, as the Jenkins job
# does.
#
# No Python is set up for this job: Make.bat downloads the version named
# in pkg/python-version.txt, so the build gets the same interpreter here
# as it does on the signing host and on a developer's machine.
- name: Check the installer build
shell: cmd
run: |
SET "PGADMIN_POSTGRES_DIR=%DEPS_DIR%\postgresql"
SET "PGADMIN_KRB5_DIR=%DEPS_DIR%\krb5"
SET "PGADMIN_INNOTOOL_DIR=C:\Program Files (x86)\Inno Setup 6"
CALL "%VS_INSTALL_DIR%\VC\Auxiliary\Build\vcvars64.bat" || EXIT /b 1
CALL Make.bat || EXIT /b 1
- name: Archive the installer
uses: actions/upload-artifact@v7
with:
name: pgadmin4-windows-build-output
if-no-files-found: error
path: dist/*.exe
+447
View File
@@ -0,0 +1,447 @@
# Promote a tested release candidate to the download server.
#
# This is the irreversible one. Everything before it produces something that
# can be rebuilt or deleted without anybody noticing; this puts packages in
# front of every pgAdmin user, and within the hour they are on the PostgreSQL
# mirror network and in the S3 archive, which has no --delete and therefore no
# undo.
#
# So it builds nothing. It takes a candidate that already exists on the
# development server, having been built, signed, indexed and installed from by
# the acceptance test, and moves it across. If a candidate needs changing, the
# answer is a new candidate rather than a repair applied here.
#
# The version is separate from the location deliberately: 2026-09-21-1 is a
# build, 9.18 is what users will call it, and conflating them is how somebody
# publishes the wrong tree under the right name.
name: Promote release
on:
workflow_dispatch:
inputs:
version:
description: 'Version to publish, for example 9.18'
required: true
type: string
location:
description: 'Candidate to promote, for example 2026-09-21-1'
required: true
type: string
confirm:
description: 'Type the version again to confirm'
required: true
type: string
container-tags:
description: >-
Space separated tags for the container, for example
"9 9.18 9.18.0 latest". Required when scope is everything.
required: false
type: string
default: ''
scope:
description: >-
How much to do. "everything" is a real promotion. "files" stops
before the website and the S3 archive, neither of which can be
undone. "release-directory" stops before the package
repositories as well, touching only v<VERSION>, which is the
only setting that leaves the live repositories alone and so the
only one safe to rehearse the download server with.
"registries" is the other half: it skips the download server
entirely and runs only the container re-tag and the chart push,
so those can be exercised against a candidate tag without a
release. It does not upload to PyPI, there being no published
wheel to upload.
type: choice
required: true
default: release-directory
options:
- release-directory
- files
- everything
- registries
concurrency:
group: 'promote-release'
cancel-in-progress: false
permissions:
contents: read
jobs:
# Every input is checked here, before either of the jobs that act on one
# runs, because the checks used to live in promote and the registries scope
# skips that job: under that scope the confirmation gate did not apply to
# the step that moves the latest tag.
check:
runs-on: ubuntu-24.04
steps:
- name: Check the request
env:
VERSION: ${{ inputs.version }}
LOCATION: ${{ inputs.location }}
CONFIRM: ${{ inputs.confirm }}
TAGS: ${{ inputs.container-tags }}
SCOPE: ${{ inputs.scope }}
run: |
set -euo pipefail
# Typed twice, because the cost of getting this wrong is a version
# published from the wrong tree and no way to unpublish it.
if [ "${VERSION}" != "${CONFIRM}" ]; then
echo "The confirmation does not match the version." >&2
exit 1
fi
# The same shapes the wrapper enforces, checked here so a mistake
# costs a second rather than a round trip.
printf '%s' "${VERSION}" | grep -Eq '^[0-9]{1,2}\.[0-9]{1,2}(\.[0-9]{1,2})?$' || {
echo "Not a version: ${VERSION}" >&2; exit 1; }
printf '%s' "${LOCATION}" | grep -Eq '^[0-9]{4}-[0-9]{2}-[0-9]{2}(-[1-9][0-9]?)?$' || {
echo "Not a build location: ${LOCATION}" >&2; exit 1; }
# Only the scopes that publish containers need tags, but when they
# are given they are checked whatever the scope, so a bad value is
# not discovered halfway through a promotion.
if [ "${SCOPE}" = "everything" ] || [ "${SCOPE}" = "registries" ]; then
[ -n "${TAGS}" ] || {
echo "container-tags is required for scope ${SCOPE}." >&2
exit 1; }
fi
# -f, because an unquoted expansion is also a glob: a tag of * would
# otherwise be replaced by whatever is in the working directory.
set -f
for tag in ${TAGS}; do
printf '%s' "${tag}" | grep -Eq '^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$' || {
echo "Not a container tag: ${tag}" >&2; exit 1; }
done
set +f
echo "Request accepted: ${VERSION} from ${LOCATION}, scope ${SCOPE}."
promote:
needs: check
# Skipped entirely when only the registries are being exercised, so a
# rehearsal of those never touches the download server.
if: ${{ inputs.scope != 'registries' }}
runs-on: [self-hosted, publish]
environment: publishing
steps:
# The inputs are checked in the job above; this is about the runner.
- name: Check the runner
env:
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
run: |
set -euo pipefail
[ -n "${DOWNLOAD}" ] || { echo "DOWNLOAD_SSH_TARGET is not set." >&2; exit 1; }
# Both variables reach option positions: the target is the first
# positional argument to every ssh below, and the key path follows
# -i, so a value beginning with a hyphen would be read as an option
# rather than as the host or the path it is meant to be. Only an
# administrator can set a repository variable, which makes this
# defence in depth rather than a live hole, but it is checked here,
# once, before anything is published; the -- at each call site
# closes the same gap from the other end.
TARGET_RE='^[A-Za-z0-9][A-Za-z0-9._-]*(@[A-Za-z0-9][A-Za-z0-9.-]*)?$'
printf '%s' "${DOWNLOAD}" | grep -Eq "${TARGET_RE}" || {
echo "DOWNLOAD_SSH_TARGET is not a [user@]host." >&2; exit 1; }
KEY="${PUBLISH_KEY/#\~/$HOME}"
printf '%s' "${KEY}" | grep -Eq '^/[A-Za-z0-9._/-]+$' || {
echo "PUBLISH_SSH_KEY is not a plain absolute path." >&2
exit 1; }
[ -r "${KEY}" ] || { echo "Missing SSH key: ${KEY}" >&2; exit 1; }
if head -c 4 "${KEY}" | grep -q '^ssh-'; then
echo "${KEY} is a public key; -i needs the private one." >&2
exit 1
fi
# Checked before anything is created, so that a version published by
# mistake is caught here rather than by release-create failing halfway
# through and leaving a directory behind.
- name: Refuse to republish
env:
VERSION: ${{ inputs.version }}
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
run: |
set -euo pipefail
publish() {
ssh -i "${PUBLISH_KEY/#\~/$HOME}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${DOWNLOAD}" "$@"
}
if publish release-exists "${VERSION}" 2>/dev/null; then
echo "Version ${VERSION} is already published." >&2
echo "Publishing is single-shot; a correction needs a new version." >&2
exit 1
fi
echo "Version ${VERSION} is not yet published."
- name: Publish the release directory
env:
VERSION: ${{ inputs.version }}
LOCATION: ${{ inputs.location }}
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
run: |
set -euo pipefail
publish() {
echo "+ $*"
ssh -i "${PUBLISH_KEY/#\~/$HOME}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${DOWNLOAD}" "$@"
}
# The downloads first: the directory, then the files sorted into it,
# then the packages into the live repository trees. Nothing is
# visible to a package manager until the indices are rebuilt below,
# so an interruption here leaves packages that nothing points at
# rather than a repository describing packages that are not there.
publish release-create "${VERSION}"
publish release-fetch "${VERSION}" "${LOCATION}"
# Separate from the step above because this is where a promotion stops
# being reversible in practice. The step above creates one directory that
# can simply be deleted; this copies packages into the live repositories
# and re-signs the indices every client reads.
- name: Publish the packages
if: ${{ inputs.scope != 'release-directory' }}
env:
VERSION: ${{ inputs.version }}
LOCATION: ${{ inputs.location }}
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
run: |
set -euo pipefail
publish() {
echo "+ $*"
ssh -i "${PUBLISH_KEY/#\~/$HOME}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${DOWNLOAD}" "$@"
}
# The auto-updater archives, which release-fetch deliberately left
# behind because they belong outside the release directory.
publish autoupdate-publish "${VERSION}"
publish packages-fetch "${LOCATION}"
# The indices, which is the point at which the new packages become
# installable.
for codename in bookworm trixie jammy noble resolute; do
publish rebuild-apt "${codename}"
done
publish rebuild-yum redhat rhel 9 x86_64
publish rebuild-yum redhat rhel 10 x86_64
publish rebuild-yum fedora fedora 43 x86_64
publish rebuild-yum fedora fedora 44 x86_64
# The platform tables carry the release history, so they change with
# every release rather than only when a platform is added.
publish rebuild-readme apt
publish rebuild-readme yum
- name: Update the website
if: ${{ inputs.scope == 'everything' }}
env:
VERSION: ${{ inputs.version }}
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
run: |
set -euo pipefail
publish() {
echo "+ $*"
ssh -i "${PUBLISH_KEY/#\~/$HOME}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${DOWNLOAD}" "$@"
}
# Separate from the packages, and after them, because the website
# announcing a release whose files are not there yet is worse than
# files sitting there unannounced for a minute.
publish create-release "${VERSION}"
publish load-docs "${VERSION}"
publish purge-cache
- name: Archive to S3
if: ${{ inputs.scope == 'everything' }}
env:
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
run: |
set -euo pipefail
# Last, and on its own, because it is the slowest step and the one
# with no undo: the sync has no --delete, so anything it copies is
# in the archive permanently.
echo "+ sync-s3"
ssh -i "${PUBLISH_KEY/#\~/$HOME}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${DOWNLOAD}" sync-s3
- name: Note what was skipped
if: ${{ inputs.scope != 'everything' }}
env:
SCOPE: ${{ inputs.scope }}
VERSION: ${{ inputs.version }}
run: |
echo "scope was ${SCOPE}, so this was not a full promotion."
if [ "${SCOPE}" = "release-directory" ]; then
echo "Only /var/ftp/pgadmin4/v${VERSION} was written. The package"
echo "repositories, the website and the S3 archive are untouched,"
echo "so removing that directory undoes this entirely."
else
echo "The website was not updated and nothing was archived to S3."
echo "The packages are live and will reach the mirrors at the next"
echo "hourly sync."
fi
# The registries, which need none of the publishing keys and no self-hosted
# runner:
# nothing here touches our servers. Separate so that a Docker Hub outage
# cannot leave a half-finished promotion on the download server, and so the
# runner holding the SSH keys never handles registry credentials.
registries:
needs: [check, promote]
# always(), because under the registries scope promote is skipped rather
# than run, and a plain needs would skip this with it. check is never
# skipped, so requiring its success is what keeps the inputs validated on
# both paths.
if: >-
${{ always()
&& needs.check.result == 'success'
&& (inputs.scope == 'everything' || inputs.scope == 'registries')
&& (needs.promote.result == 'success'
|| needs.promote.result == 'skipped') }}
runs-on: ubuntu-24.04
environment: publishing
permissions:
contents: read
# For PyPI trusted publishing, which exchanges this for a short-lived
# upload credential rather than using a stored API token.
id-token: write
# For GHCR, which needs no stored credential at all.
packages: write
steps:
- uses: actions/checkout@v7
# By commit rather than by tag, since this script is piped into a shell
# in the same job that then logs in to two registries, and a tag can be
# moved. bec5b06 is v4.3.0.
- name: Install Helm
run: |
set -euo pipefail
curl -fsSL https://raw.githubusercontent.com/helm/helm/bec5b06ed841fe5269972d864d5177944fd5970f/scripts/get-helm-3 -o get-helm-3
chmod +x get-helm-3
./get-helm-3
# Re-tagged rather than rebuilt, so what ships is the manifest the
# acceptance test ran against. imagetools works registry-side, so
# nothing is pulled or pushed through this runner.
- name: Publish the container
env:
LOCATION: ${{ inputs.location }}
TAGS: ${{ inputs.container-tags }}
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_ACTOR: ${{ github.actor }}
run: |
set -euo pipefail
# Validated by the check job. -f so that the word splitting below
# does not also glob against the workspace.
set -f
printf '%s' "${DOCKERHUB_TOKEN}" \
| docker login -u "${DOCKERHUB_USERNAME}" --password-stdin
printf '%s' "${GITHUB_TOKEN}" \
| docker login ghcr.io -u "${GITHUB_ACTOR}" --password-stdin
# Docker Hub stays canonical, because every tutorial, compose file
# and manifest in the world names dpage/pgadmin4. GHCR is published
# alongside it: organisation owned, no stored credential, and not
# subject to Docker Hub's anonymous pull limits.
for tag in ${TAGS}; do
echo "+ ${LOCATION} -> :${tag}"
docker buildx imagetools create \
--tag "dpage/pgadmin4:${tag}" \
--tag "ghcr.io/pgadmin-org/pgadmin4:${tag}" \
"dpage/pgadmin4:${LOCATION}"
done
docker logout ghcr.io
docker logout
# The chart carries the release version from pkg/helm/Chart.yaml, so
# unlike the container there is no candidate copy to re-tag: it is
# packaged and pushed once, here.
#
# To GHCR rather than Docker Hub. The chart's install base is a small
# fraction of the container's, so moving it breaks far less than moving
# the image would, oci://docker.io/dpage was an odd home for a chart in
# the first place, and it needs no stored credential here.
- name: Publish the Helm chart
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_ACTOR: ${{ github.actor }}
run: |
set -euo pipefail
printf '%s' "${GITHUB_TOKEN}" \
| helm registry login ghcr.io -u "${GITHUB_ACTOR}" --password-stdin
helm package pkg/helm
helm push pgadmin4-helm-*.tgz oci://ghcr.io/pgadmin-org
helm registry logout ghcr.io
# Fetched from the published release rather than rebuilt, so what
# reaches PyPI is the file the acceptance test installed.
- name: Collect the wheel
if: ${{ inputs.scope == 'everything' }}
env:
VERSION: ${{ inputs.version }}
run: |
set -euo pipefail
mkdir -p pypi-dist
BASE="https://ftp.postgresql.org/pub/pgadmin/pgadmin4/v${VERSION}"
WHEEL="pgadmin4-${VERSION}-py3-none-any.whl"
curl -fsS -o "pypi-dist/${WHEEL}" "${BASE}/pip/${WHEEL}"
# Beside the wheel rather than in pypi-dist, because everything in
# that directory is uploaded and PyPI has not accepted detached
# signatures since 2023.
curl -fsS -o "${WHEEL}.asc" "${BASE}/pip/${WHEEL}.asc"
ls -l pypi-dist
# The wheel arrives over TLS, which says it came from the mirror and
# nothing about what the mirror was given: the tree is replicated from
# our download server to machines we do not run, and the signature that
# has been sitting beside the file all along is the only thing that ties
# these bytes back to the key on the publishing server. Checking it
# costs a second and turns the last hop of a release into something an
# attacker cannot quietly alter.
- name: Verify the wheel before uploading it
if: ${{ inputs.scope == 'everything' }}
env:
VERSION: ${{ inputs.version }}
run: |
set -euo pipefail
curl -fsS -o packages_pgadmin_org.pub \
https://www.pgadmin.org/static/packages_pgadmin_org.pub
# A keyring of its own, holding that one key and nothing the runner
# image happened to trust already, so a signature made by any other
# key fails for want of a public key rather than passing on the
# strength of somebody else's.
GNUPGHOME=$(mktemp -d)
export GNUPGHOME
gpg --batch --import packages_pgadmin_org.pub
gpg --batch --verify "pgadmin4-${VERSION}-py3-none-any.whl.asc" \
"pypi-dist/pgadmin4-${VERSION}-py3-none-any.whl"
echo "Signature verified; the upload may proceed."
# Trusted publishing: PyPI verifies this workflow's OIDC identity, so
# there is no API token to hold, rotate or leak.
- name: Upload to PyPI
if: ${{ inputs.scope == 'everything' }}
uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
with:
packages-dir: pypi-dist
+54
View File
@@ -0,0 +1,54 @@
# Purge the cache in front of the website.
#
# Promotion purges it once, but the website edits that follow a release, the
# downloads being activated, the current version record and the news article,
# all happen afterwards and are all cached. This is the button for that, and
# for the times somebody edits the site outside a release.
#
# It takes no arguments: the verb behind it clears everything, and there is
# nothing for a caller to choose.
name: Purge website cache
on:
workflow_dispatch:
concurrency:
group: 'purge-website-cache'
cancel-in-progress: true
permissions:
contents: read
jobs:
purge:
runs-on: [self-hosted, publish]
environment: publishing
steps:
- name: Purge
env:
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
run: |
set -euo pipefail
[ -n "${DOWNLOAD}" ] || { echo "DOWNLOAD_SSH_TARGET is not set." >&2; exit 1; }
# The target is the first positional argument to ssh and the key
# path follows -i, so a value beginning with a hyphen would be read
# as an option rather than as what it is meant to be. Only an
# administrator can set a repository variable, so this is defence in
# depth rather than a live hole, but it costs a line and rules out a
# whole shape of mistake; the -- below does the same job from the
# other direction.
TARGET_RE='^[A-Za-z0-9][A-Za-z0-9._-]*(@[A-Za-z0-9][A-Za-z0-9.-]*)?$'
printf '%s' "${DOWNLOAD}" | grep -Eq "${TARGET_RE}" || {
echo "DOWNLOAD_SSH_TARGET is not a [user@]host." >&2; exit 1; }
KEY="${PUBLISH_KEY/#\~/$HOME}"
printf '%s' "${KEY}" | grep -Eq '^/[A-Za-z0-9._/-]+$' || {
echo "PUBLISH_SSH_KEY is not a plain absolute path." >&2
exit 1; }
ssh -i "${KEY}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${DOWNLOAD}" purge-cache
+439
View File
@@ -0,0 +1,439 @@
# Release candidate builds, replacing the buildfarm's pgadmin4-*-build jobs.
#
# The same builds as the nightly snapshot, published to the development server
# instead of the download server. That difference is the point: a snapshot is
# finished when it is published, whereas a candidate is published in order to
# be tested, and promoted to the download server only afterwards.
#
# developer.pgadmin.org serves this tree over HTTP as soon as it is written, so
# a candidate's repositories can be added and installed from immediately,
# rather than waiting on the hourly sync between the download server and the
# mirrors.
#
# Never scheduled. A candidate exists because somebody decided to make one.
name: Release candidate
on:
workflow_dispatch:
inputs:
location:
description: >-
Build directory name, normally today's date. A second
candidate on the same day needs a -N suffix, for example
2026-09-17-2.
required: false
default: ''
publish:
description: Upload to the development server when the build succeeds
type: boolean
required: false
default: false
concurrency:
# One candidate at a time, and never cancelled: a cancelled run can abandon a
# notarisation already submitted to Apple, and leaves the signing token in an
# unknown state.
group: 'release-candidate'
cancel-in-progress: false
permissions:
contents: read
jobs:
# The directory name, decided once. Two jobs need it and they must agree:
# the repo RPMs carry the candidate's own URL inside them, so if that job and
# the assemble job each called date(1) a run straddling midnight would ship a
# repository configuration pointing at a build that does not exist.
location:
runs-on: ubuntu-24.04
outputs:
name: ${{ steps.pick.outputs.name }}
steps:
- id: pick
env:
REQUESTED: ${{ inputs.location }}
run: |
set -euo pipefail
NAME="${REQUESTED:-}"
[ -n "${NAME}" ] || NAME=$(date +%Y-%m-%d)
# Validated here so that everything downstream, including a shell on
# the machine holding the publishing keys, is working with a name
# that cannot be anything but a date and an optional suffix. The
# wrapper on the server applies its own rule to the same value; this
# one exists so a bad input fails in five seconds rather than after
# an hour of building.
if ! printf '%s' "${NAME}" | grep -Eq '^[0-9]{4}-[0-9]{2}-[0-9]{2}(-[1-9][0-9]?)?$'; then
echo "Not a valid build location: ${NAME}" >&2
echo "Expected YYYY-MM-DD, optionally with a -N suffix." >&2
exit 1
fi
echo "Build location: ${NAME}"
echo "name=${NAME}" >> "${GITHUB_OUTPUT}"
deb:
uses: ./.github/workflows/check-deb-build.yml
rpm:
uses: ./.github/workflows/check-rpm-build.yml
tarball:
uses: ./.github/workflows/check-tarball-build.yml
wheel:
uses: ./.github/workflows/check-python-build.yml
docs:
uses: ./.github/workflows/check-doc-builds.yml
# The container, pushed to the registry under this candidate's location so
# that it can be tested and then re-tagged at promotion. Not part of the
# download tree, which is why it is not in assemble's needs.
container:
needs: location
if: inputs.publish
# The caller caps a called workflow's token: the top-level
# 'contents: read' leaves 'packages: none', so the publish-container job's
# 'packages: write' request must be granted here or the workflow is
# rejected before it starts.
permissions:
contents: read
packages: write
uses: ./.github/workflows/check-container-build.yml
with:
publish: true
location: ${{ needs.location.outputs.name }}
secrets: inherit
# The Helm chart is built as a check but not published here. Its version
# comes from pkg/helm/Chart.yaml, so pushing it would publish the release
# version before the release, and the registry has no notion of a candidate
# the way the download server does. It goes out at promotion.
helm:
uses: ./.github/workflows/check-helm-build.yml
# The repository configuration RPMs. These are not built by the QA
# workflows, because they are not a build of pgAdmin: they are a one-file
# package carrying a .repo pointing at the tree they ship in, which is why
# the URL has to be known before they are built.
repo-rpm:
needs: location
runs-on: ubuntu-24.04
container: almalinux:9
steps:
- name: Install the build environment
run: dnf install -y --setopt=install_weak_deps=False rpm-build python3 git
- uses: actions/checkout@v7
- name: Mark the workspace as a safe git directory
run: git config --global --add safe.directory "${GITHUB_WORKSPACE}"
- name: Build the repository RPMs
env:
LOCATION: ${{ needs.location.outputs.name }}
run: |
# Through the environment rather than interpolated into the script.
# The location is a dispatch input, so it is text somebody chose, and
# workflow expression substitution happens before the shell ever sees the
# line, so a crafted location would otherwise become shell text.
export PGADMIN_REPO_DIR="https://developer.pgadmin.org/builds/${LOCATION}/yum"
echo "Repositories will point at ${PGADMIN_REPO_DIR}"
pkg/redhat/repo-rpm.sh
- name: Archive the repository RPMs
uses: actions/upload-artifact@v7
with:
name: pgadmin4-repo-rpm-build-output
if-no-files-found: error
path: dist/*.noarch.rpm
# snapshot-macos.yml and snapshot-windows.yml are the signed-build
# workflows rather than snapshot-only ones; the name predates there being
# a second caller.
macos:
uses: ./.github/workflows/snapshot-macos.yml
secrets: inherit
windows:
uses: ./.github/workflows/snapshot-windows.yml
secrets: inherit
assemble:
needs: [location, deb, rpm, tarball, wheel, docs, repo-rpm, macos, windows]
# the runner, not a hosted runner. This job assembles a tree of several
# hundred megabytes and then, when publishing, sends it to the development
# server; splitting the two meant uploading that tree as an artifact and
# immediately downloading it again on the runner, having first queued for a
# hosted runner behind whatever else the organisation was building.
runs-on: [self-hosted, publish]
# For the variables naming the keys and the target, which live here. The
# environment carries no protection rules, so a run that is not publishing
# is not gated by it.
environment: publishing
# Everything must have built except Windows. That is the one runner which
# can legitimately be offline, and a candidate without the installer is
# still worth having; a candidate missing its documentation, source tarball,
# wheel or repository RPMs is not, and the repository RPMs are worse than
# missing, since install-repo-readme.py then fails after the packages have
# been uploaded and signed, leaving half a candidate on the server.
if: >-
always()
&& needs.location.result == 'success'
&& needs.deb.result == 'success'
&& needs.rpm.result == 'success'
&& needs.tarball.result == 'success'
&& needs.wheel.result == 'success'
&& needs.docs.result == 'success'
&& needs.repo-rpm.result == 'success'
&& needs.macos.result == 'success'
steps:
- uses: actions/checkout@v7
# Only the build outputs, which are all named pgadmin4-*. The container
# build also leaves a 'pgadmin-org~pgadmin4~*.dockerbuild' build-record
# artifact that docker/build-push-action uploads; it is not a release
# file, and it is not stored as a plain zip, so download-artifact fails
# to extract it and, downloading everything, fails the whole step.
- name: Collect the build artefacts
uses: actions/download-artifact@v7
with:
path: artefacts
pattern: pgadmin4-*
# The layout is the one the publishing scripts and the download site
# expect, and is what the wrapper's stage-create verb creates on the
# staging server.
# The Debian architecture comes from the package filename rather than a
# table, since dpkg already encodes it there; the codename does not, so
# that mapping is explicit.
- name: Assemble the staging tree
env:
LOCATION: ${{ needs.location.outputs.name }}
run: |
set -euo pipefail
# Flat, beside apt/ and yum/, which is how both the staging server
# and the snapshots tree are laid out. The docs/macos/pip/source/
# windows subdivision belongs to a published release, and it is the
# promotion step that sorts files into it on the way there.
# Explicitly, rather than trusting the checkout to have cleaned it.
# This runs on a self-hosted runner whose workspace persists between
# jobs, and a previous run's tree left behind here is indistinguishable
# from this one's until something downstream has to choose between
# them.
rm -rf stage
STAGE="stage/${LOCATION}"
mkdir -p "${STAGE}/yum"
# An artefact can be legitimately absent: the Windows signing host is
# allowed to be offline, and a failed matrix leg is reported by its
# own job rather than by a confusing cp error here.
copy_into() {
DEST=$1; shift
for SRC in "$@"; do
[ -e "${SRC}" ] || continue
mkdir -p "${DEST}"
cp "${SRC}" "${DEST}/"
done
}
codename_for() {
case "$1" in
debian-12) echo bookworm ;;
debian-13) echo trixie ;;
ubuntu-2204) echo jammy ;;
ubuntu-2404) echo noble ;;
ubuntu-2604) echo resolute ;;
*) echo "Unknown Debian build name: $1" >&2; exit 1 ;;
esac
}
for DIR in artefacts/pgadmin4-deb-build-output-*; do
[ -d "${DIR}" ] || continue
CODENAME=$(codename_for "${DIR##*-output-}")
for DEB in "${DIR}"/*.deb; do
ARCH=$(basename "${DEB}" .deb); ARCH=${ARCH##*_}
TARGET="${STAGE}/apt/${CODENAME}/dists/pgadmin4/main/binary-${ARCH}"
mkdir -p "${TARGET}"
cp "${DEB}" "${TARGET}/"
done
done
# RPM trees are named for the distribution, which the build name
# already carries: el-9 becomes redhat/rhel-9-x86_64.
for DIR in artefacts/pgadmin4-rpm-build-output-*; do
[ -d "${DIR}" ] || continue
NAME=${DIR##*-output-}
case "${NAME}" in
el-*) FAMILY=redhat; TREE="rhel-${NAME#el-}" ;;
fedora-*) FAMILY=fedora; TREE="${NAME}" ;;
*) echo "Unknown RPM build name: ${NAME}" >&2; exit 1 ;;
esac
# Every RPM for a distribution goes in that distribution's
# tree, including the noarch ones. Taking the directory from the
# package's own architecture would file pgadmin4 and
# pgadmin4-web, both noarch, under rhel-9-noarch, where no
# client looks: dnf asks for <name>-<version>-$basearch. The
# RPM matrix is x86_64 only for now, so this is a constant; when
# aarch64 arrives it becomes a property of the build.
TARGET="${STAGE}/yum/${FAMILY}/${TREE}-x86_64"
mkdir -p "${TARGET}"
cp "${DIR}"/*.rpm "${TARGET}/"
done
copy_into "${STAGE}" artefacts/pgadmin4-tarball-build-output/*
copy_into "${STAGE}" artefacts/pgadmin4-python-build-output/*
# The version is read once here and used for the documentation
# filenames, which the build leaves unversioned as pgadmin4.pdf and
# pgAdmin4.epub whilst the download site has always carried
# pgadmin4-<version>.pdf and .epub.
VERSION=$(python3 -c "import sys; sys.path.insert(0, 'web'); import version; print(version.APP_VERSION)")
for SRC in artefacts/pgadmin4-pdf-build-output/*.pdf; do
[ -e "${SRC}" ] && cp "${SRC}" "${STAGE}/pgadmin4-${VERSION}.pdf"
done
for SRC in artefacts/pgadmin4-epub-build-output/*.epub; do
[ -e "${SRC}" ] && cp "${SRC}" "${STAGE}/pgadmin4-${VERSION}.epub"
done
# The docs tarball is what load-docs.sh unpacks on the web server, so
# it ships as a tarball rather than as the directory of files the
# build produces.
if [ -d artefacts/pgadmin4-html-build-output ]; then
# Under a pgadmin4-<version>-docs/ directory, not flat. The
# web server's load-docs.sh unpacks this into the docs root
# and then hands docloader that directory name, so a flat
# archive would scatter several hundred files across the root
# and then fail on a directory that does not exist. Every
# released tarball has carried that top level; the tar here
# had not.
DOCS_DIR="pgadmin4-${VERSION}-docs"
rm -rf "artefacts/${DOCS_DIR}"
mv artefacts/pgadmin4-html-build-output "artefacts/${DOCS_DIR}"
tar -czf "${STAGE}/pgadmin4-${VERSION}-docs.tar.gz" \
-C artefacts "${DOCS_DIR}"
fi
# At the root of yum/, beside the family directories, which is
# where the README instructions tell people to fetch them from.
copy_into "${STAGE}/yum" artefacts/pgadmin4-repo-rpm-build-output/*
copy_into "${STAGE}" artefacts/pgadmin4-macos-snapshot-*/*
copy_into "${STAGE}" artefacts/pgadmin4-windows-snapshot/*
find "${STAGE}" -type f | sort
- name: Check the keys are present
if: inputs.publish
env:
STAGING: ${{ vars.STAGING_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
UPLOAD_KEY: ${{ vars.UPLOAD_SSH_KEY || '~/.ssh/pga-upload' }}
run: |
set -euo pipefail
for TOOL in ssh rsync; do
command -v "${TOOL}" >/dev/null || {
echo "This runner has no ${TOOL}." >&2; exit 1; }
done
# These three variables reach option positions. The target is the
# first positional argument to ssh, and the key paths are spliced
# into the -e string that rsync splits on whitespace before exec'ing
# it, so a value beginning with a hyphen, or one carrying a space,
# would be read as an option or as a second word rather than as the
# host or the path it is meant to be. Only an administrator can set
# a repository variable, which makes this defence in depth rather
# than a live hole, but it is checked here, once, rather than at
# each point of use; the -- in the publish step below closes the
# same gap from the other end.
TARGET_RE='^[A-Za-z0-9][A-Za-z0-9._-]*(@[A-Za-z0-9][A-Za-z0-9.-]*)?$'
printf '%s' "${STAGING}" | grep -Eq "${TARGET_RE}" || {
echo "STAGING_SSH_TARGET is not a [user@]host." >&2; exit 1; }
for KEY in "${PUBLISH_KEY/#\~/$HOME}" "${UPLOAD_KEY/#\~/$HOME}"; do
printf '%s' "${KEY}" | grep -Eq '^/[A-Za-z0-9._/-]+$' || {
echo "Not a plain absolute path: ${KEY}" >&2; exit 1; }
if [ ! -r "${KEY}" ]; then
echo "Missing or unreadable SSH key: ${KEY}" >&2
exit 1
fi
# A public key is readable too, and pointing -i at one fails
# later inside ssh with a message that does not mention which
# file was wrong. Both halves of a pair sit in the same
# directory with names one suffix apart, so this is an easy
# thing to configure wrongly and a cheap thing to catch.
if head -c 4 "${KEY}" | grep -q '^ssh-'; then
echo "${KEY} is a public key; -i needs the private one." >&2
echo "Drop the .pub suffix from the variable that names it." >&2
exit 1
fi
done
if [ ! -r ~/.ssh/known_hosts ]; then
echo "This runner has no ~/.ssh/known_hosts, so host key" >&2
echo "checking would fail. Add the servers' host keys." >&2
exit 1
fi
- name: Publish the candidate
if: inputs.publish
env:
STAGING: ${{ vars.STAGING_SSH_TARGET }}
LOCATION: ${{ inputs.location }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
UPLOAD_KEY: ${{ vars.UPLOAD_SSH_KEY || '~/.ssh/pga-upload' }}
run: |
set -euo pipefail
if [ -z "${STAGING}" ]; then
echo "The STAGING_SSH_TARGET variable is not set." >&2
exit 1
fi
# One directory came out of assemble, named for the date. An explicit
# location overrides it so that a test run does not land on the
# build the buildfarm is still writing on the same server.
# assemble produces exactly one directory, named for the date.
# Anything else means the artefact is not what this step thinks it
# is, and guessing which one to publish is not a decision to make at
# three in the morning.
if [ "$(find stage -mindepth 1 -maxdepth 1 -type d | wc -l)" != "1" ]; then
echo "Expected one directory in the build artefact:" >&2
ls -l stage >&2
exit 1
fi
BUILT=$(basename "$(find stage -mindepth 1 -maxdepth 1 -type d)")
DEST=${LOCATION:-${BUILT}}
echo "Publishing ${BUILT} as ${DEST}"
publish() {
ssh -i "${PUBLISH_KEY/#\~/$HOME}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${STAGING}" "$@"
}
publish stage-create "${DEST}"
# No --delete, deliberately: rrsync refuses it anyway, and a
# publishing step that can remove things is a publishing step that
# can remove the wrong things.
rsync -rlt --safe-links --no-specials --no-devices \
-e "ssh -i ${UPLOAD_KEY/#\~/$HOME} -o BatchMode=yes -o StrictHostKeyChecking=yes" \
"stage/${BUILT}/" "${STAGING}:${DEST}/"
# Signing before indexing: the metadata has to describe the signed
# packages rather than the unsigned ones just uploaded.
publish stage-sign "${DEST}"
publish stage-index-apt "${DEST}"
publish stage-index-yum "${DEST}"
# Installing from the candidate, which is the only check that proves a user
# could have. It gates nothing automatically yet, promotion still being a
# human decision, but a red result here is a candidate that must not be
# promoted.
acceptance:
needs: [location, assemble]
if: inputs.publish
uses: ./.github/workflows/acceptance-test.yml
with:
base-url: https://developer.pgadmin.org/builds/${{ needs.location.outputs.name }}
+30 -9
View File
@@ -3,8 +3,28 @@ name: Run feature tests on EPAS
on:
push:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/run-feature-tests-epas.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/run-feature-tests-epas.yml'
workflow_dispatch:
@@ -26,7 +46,7 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Setup the EDB APT repo on Linux
run: |
@@ -141,15 +161,16 @@ jobs:
}
EOF
- name: Upgrade yarn
run: |
yarn set version berry
yarn set version 4
# Corepack reads packageManager from web/package.json and provisions
# exactly that Yarn: a single pinned download, with nothing written
# into the checkout.
- name: Enable Corepack
run: corepack enable
- name: Build the JS bundle
run: |
cd web
yarn install
yarn install --immutable
yarn run bundle
- name: Run the tests
@@ -162,21 +183,21 @@ jobs:
- name: Archive server log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: server-log-pg${{ matrix.pgver }}
path: var/pgadmin4.log
- name: Archive regression log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: regression-log-pg${{ matrix.pgver }}
path: web/regression/regression.log
- name: Archive screenshots
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: screenshots-pg${{ matrix.pgver }}
path: web/regression/screenshots
+30 -9
View File
@@ -6,8 +6,28 @@ name: Run feature tests on PostgreSQL
on:
push:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/run-feature-tests-pg.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/run-feature-tests-pg.yml'
workflow_dispatch:
@@ -25,7 +45,7 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Setup the PGDG APT repo
run: |
@@ -151,15 +171,16 @@ jobs:
}
EOF
- name: Upgrade yarn
run: |
yarn set version berry
yarn set version 4
# Corepack reads packageManager from web/package.json and provisions
# exactly that Yarn: a single pinned download, with nothing written
# into the checkout.
- name: Enable Corepack
run: corepack enable
- name: Build the JS bundle
run: |
cd web
yarn install
yarn install --immutable
yarn run bundle
- name: Run the tests
@@ -172,21 +193,21 @@ jobs:
- name: Archive server log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: server-log-pg${{ matrix.pgver }}
path: var/pgadmin4.log
- name: Archive regression log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: regression-log-pg${{ matrix.pgver }}
path: web/regression/regression.log
- name: Archive screenshots
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: screenshots-pg${{ matrix.pgver }}
path: web/regression/screenshots
+30 -7
View File
@@ -3,8 +3,30 @@ name: Run Javascript tests
on:
push:
branches: [ "master" ]
paths:
- 'web/**/*.js'
- 'web/**/*.jsx'
- 'web/package.json'
- 'web/yarn.lock'
- 'web/jest.config.js'
- 'web/webpack.shim.js'
- 'web/regression/javascript/**'
- 'web/.yarnrc.yml'
- 'web/babel.config.json'
- '.github/workflows/run-javascript-tests.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**/*.js'
- 'web/**/*.jsx'
- 'web/package.json'
- 'web/yarn.lock'
- 'web/jest.config.js'
- 'web/webpack.shim.js'
- 'web/regression/javascript/**'
- 'web/.yarnrc.yml'
- 'web/babel.config.json'
- '.github/workflows/run-javascript-tests.yml'
workflow_dispatch:
@@ -22,21 +44,22 @@ jobs:
runs-on: ${{ matrix.os }}
steps:
- uses: actions/setup-node@v4
- uses: actions/setup-node@v7
with:
node-version: '20.x'
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Upgrade yarn
run: |
yarn set version berry
yarn set version 4
# Corepack reads packageManager from web/package.json and provisions
# exactly that Yarn: a single pinned download, with nothing written
# into the checkout.
- name: Enable Corepack
run: corepack enable
- name: Install Node modules
run: |
cd web
yarn install
yarn install --immutable
- name: Run the tests
run: |
+26 -4
View File
@@ -13,8 +13,30 @@ name: Run Python tests on EPAS
on:
push:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- 'tools/get_sb_package.py'
- '.github/workflows/run-python-tests-epas.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- 'tools/get_sb_package.py'
- '.github/workflows/run-python-tests-epas.yml'
workflow_dispatch:
@@ -48,10 +70,10 @@ jobs:
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Update python version
uses: actions/setup-python@v5
uses: actions/setup-python@v7
with:
python-version: '3.10'
@@ -311,14 +333,14 @@ jobs:
- name: Archive server log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: server-log-epas-${{ matrix.os }}-pg${{ matrix.pgver }}
path: var/pgadmin4.log
- name: Archive regression log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: regression-log-epas-${{ matrix.os }}-pg${{ matrix.pgver }}
path: web/regression/regression.log
+78 -4
View File
@@ -6,10 +6,37 @@ name: Run Python tests on PostgreSQL
on:
push:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- 'tools/get_sb_package.py'
- '.github/workflows/run-python-tests-pg.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- 'tools/get_sb_package.py'
- '.github/workflows/run-python-tests-pg.yml'
workflow_dispatch:
inputs:
pg_timetable_version:
description: 'pg_timetable version to install for the tests'
required: false
type: string
concurrency:
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
@@ -17,6 +44,8 @@ concurrency:
jobs:
run-python-tests-pg:
env:
PG_TIMETABLE_VERSION: ${{ inputs.pg_timetable_version || '6.3.0' }}
strategy:
fail-fast: false
matrix:
@@ -26,10 +55,10 @@ jobs:
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- name: Update python version
uses: actions/setup-python@v5
uses: actions/setup-python@v7
with:
python-version: '3.10'
@@ -143,6 +172,38 @@ jobs:
psql postgres -p 59${{ matrix.pgver }} -c 'CREATE ROLE postgres SUPERUSER LOGIN;'
# pg_timetable tables are created by the agent and need the agent to test run_now.
- name: Install and start pg_timetable on Linux
if: ${{ matrix.os == 'ubuntu-22.04' }}
run: |
wget --quiet -O /tmp/pg_timetable.tar.gz https://github.com/cybertec-postgresql/pg_timetable/releases/download/v${{ env.PG_TIMETABLE_VERSION }}/pg_timetable_Linux_x86_64.tar.gz
tar -xzf /tmp/pg_timetable.tar.gz -C /tmp --strip-components=1
/tmp/pg_timetable --init --clientname=runner "host=/var/run/postgresql port=59${{ matrix.pgver }} dbname=postgres user=postgres"
nohup /tmp/pg_timetable --clientname=runner "host=/var/run/postgresql port=59${{ matrix.pgver }} dbname=postgres user=postgres" > /tmp/pg_timetable.log 2>&1 &
echo $! > /tmp/pg_timetable.pid
sleep 2
- name: Install and start pg_timetable on macOS
if: ${{ matrix.os == 'macos-latest' }}
run: |
curl -sSL -o /tmp/pg_timetable.tar.gz https://github.com/cybertec-postgresql/pg_timetable/releases/download/v${{ env.PG_TIMETABLE_VERSION }}/pg_timetable_Darwin_arm64.tar.gz
tar -xzf /tmp/pg_timetable.tar.gz -C /tmp --strip-components=1
/tmp/pg_timetable --init --clientname=runner "host=/tmp port=59${{ matrix.pgver }} dbname=postgres user=postgres"
nohup /tmp/pg_timetable --clientname=runner "host=/tmp port=59${{ matrix.pgver }} dbname=postgres user=postgres" > /tmp/pg_timetable.log 2>&1 &
echo $! > /tmp/pg_timetable.pid
sleep 2
- name: Install and start pg_timetable on Windows
if: ${{ matrix.os == 'windows-latest' }}
shell: pwsh
run: |
$env:PGPASSWORD = 'postgres'
curl.exe -sSL -o pg_timetable.zip https://github.com/cybertec-postgresql/pg_timetable/releases/download/v${{ env.PG_TIMETABLE_VERSION }}/pg_timetable_Windows_x86_64.zip
Expand-Archive -Path pg_timetable.zip -DestinationPath .
& .\pg_timetable_Windows_x86_64\pg_timetable.exe --init --clientname=runner "postgresql://postgres:postgres@127.0.0.1:59${{ matrix.pgver }}/postgres"
Start-Process -FilePath .\pg_timetable_Windows_x86_64\pg_timetable.exe -ArgumentList @('--clientname=runner', "postgresql://postgres:postgres@127.0.0.1:59${{ matrix.pgver }}/postgres") -RedirectStandardError .\pg_timetable_Windows_x86_64\pg_timetable.err -NoNewWindow
Start-Sleep -Seconds 3
- name: Install Python dependencies on Linux and macOS
if: ${{ matrix.os == 'macos-latest' || matrix.os == 'ubuntu-22.04' }}
run: make install-python-testing
@@ -318,16 +379,29 @@ jobs:
python web\regression\runtests.py --exclude feature_tests
shell: cmd
- name: Stop pg_timetable on Linux and macOS
if: always() && (matrix.os == 'macos-latest' || matrix.os == 'ubuntu-22.04')
run: |
if [ -f /tmp/pg_timetable.pid ]; then
kill $(cat /tmp/pg_timetable.pid) 2>/dev/null || true
fi
- name: Stop pg_timetable on Windows
if: always() && matrix.os == 'windows-latest'
shell: pwsh
run: |
Get-Process -Name pg_timetable -ErrorAction SilentlyContinue | Stop-Process -Force
- name: Archive server log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: server-log-${{ matrix.os }}-pg${{ matrix.pgver }}
path: var/pgadmin4.log
- name: Archive regression log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: regression-log-${{ matrix.os }}-pg${{ matrix.pgver }}
path: web/regression/regression.log
@@ -15,8 +15,28 @@ name: Run Python tests in server mode (data isolation)
on:
push:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/run-python-tests-server-mode.yml'
pull_request:
branches: [ "master" ]
paths:
- 'web/**'
# Not the message catalogues: a .po change cannot break a build or a
# test, and check-translations already compiles them, which is the
# check that would catch a malformed one.
- '!web/pgadmin/translations/**'
- 'requirements.txt'
- 'Makefile'
- 'tools/setup-python-env.sh'
- '.github/workflows/run-python-tests-server-mode.yml'
workflow_dispatch:
@@ -32,7 +52,7 @@ jobs:
PG_VER: 18
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
with:
# We don't run any authenticated git operations after checkout
# (no push, no submodule fetch, no comment back to the PR), so
@@ -41,7 +61,7 @@ jobs:
persist-credentials: false
- name: Update python version
uses: actions/setup-python@v5
uses: actions/setup-python@v7
with:
python-version: '3.10'
@@ -191,14 +211,14 @@ jobs:
- name: Archive server log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: server-log-server-mode
path: var/pgadmin4.log
- name: Archive regression log
if: success() || failure()
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: regression-log-server-mode
path: web/regression/regression.log
+179
View File
@@ -0,0 +1,179 @@
# Signed, notarised macOS snapshot builds, replacing the buildfarm's
# pgadmin4-appbundle-snapshot job.
#
# Unlike check-macos-build.yml this produces something distributable: the
# bundle is signed with the Developer ID, notarised by Apple and stapled, and a
# ZIP is built alongside the DMG because the Electron auto-updater consumes the
# ZIP whilst the DMG is the primary download.
#
# Uploading is deliberately not wired up yet. This proves the signed build
# works; publishing comes after.
#
# Triggered by hand for now rather than nightly, so it cannot start signing
# things before we mean it to.
name: Snapshot - macOS
on:
# Callable from snapshot.yml so that the orchestrator produces one
# complete tree. Signing stays here rather than moving to the
# servers like the GPG signing did, because the Apple and Certum
# credentials cannot follow it.
workflow_call:
workflow_dispatch:
concurrency:
# Not cancel-in-progress, unlike the QA builds. Cancelling a signing build
# partway through wastes forty minutes of work and, worse, can abandon a
# notarisation already submitted to Apple, leaving a request sitting in their
# queue for a build nobody will collect. Queue instead.
# Spelled out rather than taken from github.workflow, which in a
# reusable workflow is the CALLER's name, so every workflow Snapshot
# calls would otherwise share one group.
group: 'snapshot-macos @ ${{ github.ref }}'
cancel-in-progress: false
permissions:
contents: read
jobs:
appbundle:
runs-on: ${{ matrix.runner }}
# The signing credentials live on an environment rather than loose on the
# repository, so only the workflows that should be signing can reach them.
environment: signing
strategy:
fail-fast: false
matrix:
include:
- { name: 'arm64', arch: 'arm64', runner: 'macos-15' }
- { name: 'x64', arch: 'x86_64', runner: 'macos-26-intel' }
timeout-minutes: 180
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v7
with:
node-version: '20.x'
- name: Enable Corepack
run: corepack enable
- name: Install the build dependencies
run: brew install syft wget
- name: Install the PostgreSQL build dependencies
uses: ./.github/actions/install-pgbuild-deps
with:
arch: ${{ matrix.arch }}
# The buildfarm keeps the Developer ID in the worker's login keychain and
# unlocks it with devkeys/unlock-csc.sh. A hosted runner has no such
# keychain, so one is created for this job alone and destroyed after it,
# which is also why the password is generated rather than configured: it
# never outlives the job.
- name: Import the signing certificate
env:
MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
MACOS_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }}
run: |
KEYCHAIN="${RUNNER_TEMP}/build.keychain"
KEYCHAIN_PASSWORD=$(uuidgen)
echo "KEYCHAIN=${KEYCHAIN}" >> "${GITHUB_ENV}"
echo "${MACOS_CERTIFICATE}" | base64 --decode > "${RUNNER_TEMP}/cert.p12"
security create-keychain -p "${KEYCHAIN_PASSWORD}" "${KEYCHAIN}"
security set-keychain-settings -lut 21600 "${KEYCHAIN}"
security unlock-keychain -p "${KEYCHAIN_PASSWORD}" "${KEYCHAIN}"
security import "${RUNNER_TEMP}/cert.p12" \
-k "${KEYCHAIN}" \
-P "${MACOS_CERTIFICATE_PASSWORD}" \
-T /usr/bin/codesign
# Without this, codesign prompts for permission to use the key, which
# on a headless runner means hanging until the job times out.
security set-key-partition-list -S apple-tool:,apple:,codesign: \
-s -k "${KEYCHAIN_PASSWORD}" "${KEYCHAIN}" > /dev/null
security list-keychain -d user -s "${KEYCHAIN}" login.keychain
rm -f "${RUNNER_TEMP}/cert.p12"
echo "Identities available to codesign:"
security find-identity -v -p codesigning "${KEYCHAIN}"
# build.sh decides whether to sign and notarise purely by whether these
# files exist, which is what keeps the QA build credential-free.
- name: Write the signing configuration
env:
MACOS_DEVELOPER_ID: ${{ secrets.MACOS_DEVELOPER_ID }}
APPLE_ID: ${{ secrets.APPLE_ID }}
APPLE_APP_SPECIFIC_PASSWORD: ${{ secrets.APPLE_APP_SPECIFIC_PASSWORD }}
APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
run: |
printf 'DEVELOPER_ID="%s"\n' "${MACOS_DEVELOPER_ID}" > pkg/mac/codesign.conf
{
printf 'DEVELOPER_USER=%s\n' "${APPLE_ID}"
printf 'DEVELOPER_ASP=%s\n' "${APPLE_APP_SPECIFIC_PASSWORD}"
printf 'DEVELOPER_TEAM_ID=%s\n' "${APPLE_TEAM_ID}"
} > pkg/mac/notarization.conf
# --zip as well as the DMG: the DMG is the download, the ZIP is what the
# Electron auto-updater fetches. The buildfarm's snapshot job does the
# same.
- name: Build the signed appbundle
run: |
export PGADMIN_POSTGRES_DIR=/opt/pgbuild/postgresql
export OPENSSL_DIR=/opt/pgbuild/openssl
export OPENSSL_STATIC=1
make appbundle BUILD_OPTS="--zip"
- name: Verify the signature and notarisation
run: |
APP="mac-build/pgAdmin 4.app"
echo "=== codesign ==="
codesign --verify --deep --strict --verbose=2 "${APP}"
codesign -dvvv "${APP}" 2>&1 | grep -E 'Authority|TeamIdentifier|Identifier='
echo "=== gatekeeper assessment ==="
spctl --assess --type execute --verbose=4 "${APP}"
echo "=== stapled notarisation ==="
# stapler looks the ticket up in Apple's CloudKit, and a dropped
# connection there fails the step with error 68, so it is retried.
# A genuinely broken ticket still fails all three attempts.
validate() {
for attempt in 1 2 3; do
xcrun stapler validate "$1" && return 0
[ "${attempt}" -lt 3 ] || return 1
echo "stapler validate failed; retrying in $((attempt * 30))s"
sleep $((attempt * 30))
done
}
validate "${APP}"
for F in dist/*.dmg; do
echo "--- ${F} ---"
validate "${F}"
done
- name: Archive the disk image and zip
uses: actions/upload-artifact@v7
with:
name: pgadmin4-macos-snapshot-${{ matrix.name }}
if-no-files-found: error
path: |
dist/*.dmg
dist/*.zip
# Runs even on failure: a keychain holding a Developer ID key must not
# outlive the job that created it, and the conf files carry the Apple
# credentials.
- name: Clean up the credentials
if: always()
run: |
rm -f pkg/mac/codesign.conf pkg/mac/notarization.conf
if [ -n "${KEYCHAIN:-}" ] && [ -f "${KEYCHAIN}" ]; then
security delete-keychain "${KEYCHAIN}"
fi
+180
View File
@@ -0,0 +1,180 @@
# Signed Windows snapshot builds, replacing the buildfarm's
# pgadmin4-windows-x64-snapshot job.
#
# This is the one workflow that cannot use a hosted runner. The certificate is
# on a Certum hardware token plugged into a machine we host ourselves, reached
# through the Windows machine certificate store, and a PIN handler answers the
# prompt from the interactive desktop session. None of that can be moved to a
# runner GitHub provides.
#
# Uploading is not wired up yet; this proves the signed build works.
#
# The runner must be running in the logged-in interactive session, not as a
# Windows service. A service runs in session 0 with no desktop, so the PIN
# prompt appears where the handler cannot see it and signing hangs rather than
# failing.
name: Snapshot - Windows
on:
# Callable from snapshot.yml so that the orchestrator produces one
# complete tree. Signing stays here rather than moving to the
# servers like the GPG signing did, because the Apple and Certum
# credentials cannot follow it.
workflow_call:
workflow_dispatch:
concurrency:
# Serialised deliberately, and not cancel-in-progress. There is one hardware
# token, and two builds signing through it at once is a good way to find out
# what proCertum does under contention. Jenkins may also be using it.
group: 'windows-signing'
cancel-in-progress: false
permissions:
contents: read
jobs:
installer:
runs-on: [self-hosted, windows-x64]
timeout-minutes: 120
environment: signing
env:
POSTGRES_MAJOR: '18'
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v7
with:
node-version: '20.x'
- name: Enable Corepack
run: corepack enable
# No Python step, and none needed. actions/setup-python hangs on this
# runner: it installs Python rather than unpacking it, and anything
# raising a UAC prompt in the auto-logged-in session waits forever with
# nobody to answer it, exactly as the card's PIN dialog would. The first
# attempt sat on that step for thirty minutes against eleven seconds for
# setup-node. Using whatever Python is on PATH avoids the hang and is
# worse: this machine has 3.14 installed whilst the released installers
# carry 3.13, so it would have quietly shipped a different interpreter
# from the one the macOS build ships.
#
# Make.bat now downloads the version named in pkg/python-version.txt
# itself, as a plain tarball with no installer and so no prompt, which
# settles both problems and means this host needs no Python at all.
# Unlike the hosted build, nothing is installed here. This machine is
# configured by hand rather than by Ansible, it is the only one in the
# pipeline that cannot simply be rebuilt, and a CI job has no business
# mutating it. So check, and stop with something useful to act on rather
# than failing halfway through a build.
- name: Verify the build prerequisites
shell: powershell
run: |
$missing = @()
if (-not (Test-Path "C:\Program Files (x86)\Inno Setup 6\ISCC.exe")) { $missing += "innosetup" }
foreach ($tool in @('syft', 'wget')) {
if (-not (Get-Command $tool -ErrorAction SilentlyContinue)) { $missing += $tool }
}
if ($missing.Count) {
throw ("Missing build prerequisites on this runner: $($missing -join ', '). " +
"Install with: choco install $($missing -join ' ') -y")
}
Write-Output "All prerequisites present."
- name: Install the PostgreSQL and Kerberos dependencies
id: deps
uses: ./.github/actions/install-pgbuild-deps
with:
arch: x86_64
postgres-major: ${{ env.POSTGRES_MAJOR }}
- name: Record the dependency location
shell: powershell
run: '"DEPS_DIR=${{ steps.deps.outputs.prefix }}" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append'
# Discovered rather than hardcoded. The buildfarm pins these to specific
# paths in its Jenkins node configuration, which needs editing every time
# Visual Studio or the Windows SDK updates, and that configuration is
# going away with the buildfarm.
- name: Locate the toolchain
shell: powershell
run: |
$vswhere = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe"
$vs = & $vswhere -latest -products * -property installationPath
if (-not $vs) { throw "Could not locate a Visual Studio installation" }
$redist = Get-ChildItem "$vs\VC\Redist\MSVC" -Directory |
Where-Object { Test-Path "$($_.FullName)\vc_redist.x64.exe" } |
Sort-Object Name -Descending | Select-Object -First 1
if (-not $redist) { throw "Could not locate vc_redist.x64.exe under $vs" }
# signtool lives under the SDK's versioned bin directory, and also in
# the App Certification Kit, which is where the buildfarm points at.
# Take the newest SDK copy, falling back to the ACK one.
$signtool = Get-ChildItem "${env:ProgramFiles(x86)}\Windows Kits\10\bin" `
-Filter signtool.exe -Recurse -ErrorAction SilentlyContinue |
Where-Object { $_.FullName -match '\\x64\\' } |
Sort-Object FullName -Descending | Select-Object -First 1
if (-not $signtool) {
$ack = "${env:ProgramFiles(x86)}\Windows Kits\10\App Certification Kit\signtool.exe"
if (Test-Path $ack) { $signtool = Get-Item $ack }
}
if (-not $signtool) { throw "Could not locate signtool.exe" }
Write-Output "Visual Studio: $vs"
Write-Output "VC++ redist: $($redist.FullName)"
Write-Output "signtool: $($signtool.DirectoryName)"
"VS_INSTALL_DIR=$vs" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
"PGADMIN_VCREDIST_DIR=$($redist.FullName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
"PGADMIN_SIGNTOOL_DIR=$($signtool.DirectoryName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
# Setting PGADMIN_WINDOWS_CSC is what makes Make.bat sign: it selects the
# certificate by subject name from the machine store, where proCertum
# installed it. Kept in a repository variable rather than the tree, so a
# certificate renewal is a settings change rather than a commit.
- name: Build the signed installer
shell: cmd
env:
PGADMIN_WINDOWS_CSC: ${{ vars.PGADMIN_WINDOWS_CSC }}
run: |
IF "%PGADMIN_WINDOWS_CSC%" == "" (
ECHO ERROR: the PGADMIN_WINDOWS_CSC repository variable is not set,
ECHO so Make.bat would silently produce an unsigned build.
EXIT /b 1
)
SET "PGADMIN_POSTGRES_DIR=%DEPS_DIR%\postgresql"
SET "PGADMIN_KRB5_DIR=%DEPS_DIR%\krb5"
SET "PGADMIN_INNOTOOL_DIR=C:\Program Files (x86)\Inno Setup 6"
CALL "%VS_INSTALL_DIR%\VC\Auxiliary\Build\vcvars64.bat" || EXIT /b 1
CALL Make.bat || EXIT /b 1
# Make.bat now fails the build if either signature fails, the executable
# inside the installer included, so this is a second opinion rather than
# the only check. It verifies what is in dist/, which is the installer;
# the executable within it is covered by Make.bat refusing to continue.
- name: Verify the signatures
shell: powershell
run: |
$signtool = Join-Path $env:PGADMIN_SIGNTOOL_DIR 'signtool.exe'
Get-ChildItem dist\*.exe | ForEach-Object {
Write-Output "--- $($_.Name) ---"
& $signtool verify /pa /v $_.FullName
if ($LASTEXITCODE -ne 0) { throw "Signature verification failed for $($_.Name)" }
}
- name: Archive the installer
uses: actions/upload-artifact@v7
with:
name: pgadmin4-windows-snapshot
if-no-files-found: error
path: dist/*.exe
+465
View File
@@ -0,0 +1,465 @@
# Nightly snapshot builds, replacing the buildfarm's pgadmin4-all-snapshot job
# and the dozen per-artefact snapshot jobs it drives.
#
# Nothing here is a second definition of a build. Every artefact comes from the
# same workflow that runs on each push, called rather than copied, so a
# snapshot cannot quietly diverge from what QA tested. That was not true of the
# buildfarm, where pgadmin4-deb-build and pgadmin4-deb-snapshot were separate
# job definitions carrying the same commands.
#
# Nothing here signs anything either, beyond the macOS notarisation and the
# Windows Authenticode signature, which have to happen where their credentials
# are. The GPG key that signs the RPMs and the repository metadata stays on the
# servers: this workflow assembles the tree and uploads it, and asks the
# staging server to
# index and sign, so a compromised workflow run can ask for a signature but
# never holds the means to make one.
name: Snapshot
on:
workflow_dispatch:
inputs:
location:
description: >-
Snapshot directory name, normally today's date. The buildfarm
writes <date> on the same server, so a test run wants a -N
suffix, for example 2026-09-17-2.
required: false
default: ''
publish:
description: Upload to the download server when the build succeeds
type: boolean
required: false
default: false
# Nightly, matching the buildfarm's pgadmin4-all-snapshot, which ran at
# 01:01. GitHub's scheduler is best-effort and runs late under load, which
# does not matter for a snapshot: the directory is named for the date the
# run assembles it, not for the minute it started.
schedule:
- cron: '1 1 * * *'
concurrency:
# One snapshot at a time, and never cancelled: a cancelled run can abandon a
# notarisation already submitted to Apple, and leaves the signing token in an
# unknown state.
group: 'snapshot'
cancel-in-progress: false
permissions:
contents: read
jobs:
# The directory name, decided once. Two jobs need it and they must agree:
# the repo RPMs carry the snapshot's own URL inside them, so if that job and
# the assemble job each called date(1) a run straddling midnight would ship a
# repository configuration pointing at a snapshot that does not exist.
#
# It is also where a scheduled run on a fork stops. A fork with Actions
# enabled inherits the schedule but none of the signing secrets or
# self-hosted runners, so the macOS jobs would fail at the certificate and
# the Windows job would queue for a day. Every other job waits on this one,
# so skipping it skips the run. A dispatch still runs anywhere.
location:
if: >-
github.event_name != 'schedule'
|| github.repository == 'pgadmin-org/pgadmin4'
runs-on: ubuntu-24.04
outputs:
name: ${{ steps.pick.outputs.name }}
# Whether a location was asked for by name, which decides both what the
# published directory is called and whether retention runs. It travels
# as a flag so that the steps downstream never need the raw input to
# work out what was requested: this job is where that input is checked,
# and a value that has not been through the check below has no business
# reaching the machine holding the publishing keys.
named: ${{ steps.pick.outputs.named }}
steps:
- id: pick
env:
REQUESTED: ${{ inputs.location }}
run: |
set -euo pipefail
NAME="${REQUESTED:-}"
if [ -n "${NAME}" ]; then NAMED=yes; else NAMED=no; fi
[ -n "${NAME}" ] || NAME=$(date +%Y-%m-%d)
# Validated here so that everything downstream, including a shell on
# the machine holding the publishing keys, is working with a name
# that cannot be anything but a date and an optional suffix. The
# wrapper on the server applies its own rule to the same value; this
# one exists so a bad input fails in five seconds rather than after
# an hour of building.
if ! printf '%s' "${NAME}" | grep -Eq '^[0-9]{4}-[0-9]{2}-[0-9]{2}(-[1-9][0-9]?)?$'; then
echo "Not a valid snapshot location: ${NAME}" >&2
echo "Expected YYYY-MM-DD, optionally with a -N suffix." >&2
exit 1
fi
echo "Snapshot location: ${NAME}"
echo "name=${NAME}" >> "${GITHUB_OUTPUT}"
echo "named=${NAMED}" >> "${GITHUB_OUTPUT}"
deb:
needs: location
uses: ./.github/workflows/check-deb-build.yml
rpm:
needs: location
uses: ./.github/workflows/check-rpm-build.yml
tarball:
needs: location
uses: ./.github/workflows/check-tarball-build.yml
wheel:
needs: location
uses: ./.github/workflows/check-python-build.yml
docs:
needs: location
uses: ./.github/workflows/check-doc-builds.yml
# No helm job here. The chart is not part of the download tree: the
# buildfarm pushed it to an OCI registry, which nothing in this workflow
# does yet. Calling the build and then discarding its artefact, which is what
# happened before, cost a runner and proved nothing that check-helm-build
# does not already prove on every push.
# The repository configuration RPMs. These are not built by the QA
# workflows, because they are not a build of pgAdmin: they are a one-file
# package carrying a .repo pointing at the tree they ship in, which is why
# the URL has to be known before they are built.
repo-rpm:
needs: location
runs-on: ubuntu-24.04
container: almalinux:9
steps:
- name: Install the build environment
run: dnf install -y --setopt=install_weak_deps=False rpm-build python3 git
- uses: actions/checkout@v7
- name: Mark the workspace as a safe git directory
run: git config --global --add safe.directory "${GITHUB_WORKSPACE}"
- name: Build the repository RPMs
env:
LOCATION: ${{ needs.location.outputs.name }}
run: |
# Through the environment rather than interpolated into the script.
# The location is a dispatch input, so it is text somebody chose, and
# workflow expression substitution happens before the shell ever sees the
# line, so a crafted location would otherwise become shell text.
export PGADMIN_REPO_DIR="https://ftp.postgresql.org/pub/pgadmin/pgadmin4/snapshots/${LOCATION}/yum"
echo "Repositories will point at ${PGADMIN_REPO_DIR}"
pkg/redhat/repo-rpm.sh
- name: Archive the repository RPMs
uses: actions/upload-artifact@v7
with:
name: pgadmin4-repo-rpm-build-output
if-no-files-found: error
path: dist/*.noarch.rpm
macos:
needs: location
uses: ./.github/workflows/snapshot-macos.yml
secrets: inherit
windows:
needs: location
uses: ./.github/workflows/snapshot-windows.yml
secrets: inherit
assemble:
needs: [location, deb, rpm, tarball, wheel, docs, repo-rpm, macos, windows]
# the runner, not a hosted runner. This job assembles a tree of several
# hundred megabytes and then, when publishing, sends it to the download
# server; splitting the two meant uploading that tree as an artifact and
# immediately downloading it again on the runner, having first queued for a
# hosted runner behind whatever else the organisation was building.
runs-on: [self-hosted, publish]
# For the variables naming the keys and the target, which live here. The
# environment carries no protection rules, so a run that is not publishing
# is not gated by it.
environment: publishing
# Everything must have built except Windows. That is the one runner which
# can legitimately be offline, and a snapshot without the installer is
# still worth having; a snapshot missing its documentation, source tarball,
# wheel or repository RPMs is not, and the repository RPMs are worse than
# missing, since install-repo-readme.py then fails after the packages have
# been uploaded and signed, leaving half a snapshot on the download server.
if: >-
always()
&& needs.location.result == 'success'
&& needs.deb.result == 'success'
&& needs.rpm.result == 'success'
&& needs.tarball.result == 'success'
&& needs.wheel.result == 'success'
&& needs.docs.result == 'success'
&& needs.repo-rpm.result == 'success'
&& needs.macos.result == 'success'
steps:
- uses: actions/checkout@v7
- name: Collect the build artefacts
uses: actions/download-artifact@v7
with:
path: artefacts
# The layout is the one the publishing scripts and the download site
# expect, and is what the wrapper's stage-create verb creates on the
# staging server.
# The Debian architecture comes from the package filename rather than a
# table, since dpkg already encodes it there; the codename does not, so
# that mapping is explicit.
- name: Assemble the staging tree
env:
LOCATION: ${{ needs.location.outputs.name }}
run: |
set -euo pipefail
# Flat, beside apt/ and yum/, which is how both the staging server
# and the snapshots tree are laid out. The docs/macos/pip/source/
# windows subdivision belongs to a published release, and it is the
# promotion step that sorts files into it on the way there.
# Explicitly, rather than trusting the checkout to have cleaned it.
# This runs on a self-hosted runner whose workspace persists between
# jobs, and a previous run's tree left behind here is indistinguishable
# from this one's until something downstream has to choose between
# them.
rm -rf stage
STAGE="stage/${LOCATION}"
mkdir -p "${STAGE}/yum"
# An artefact can be legitimately absent: the Windows signing host is
# allowed to be offline, and a failed matrix leg is reported by its
# own job rather than by a confusing cp error here.
copy_into() {
DEST=$1; shift
for SRC in "$@"; do
[ -e "${SRC}" ] || continue
mkdir -p "${DEST}"
cp "${SRC}" "${DEST}/"
done
}
codename_for() {
case "$1" in
debian-12) echo bookworm ;;
debian-13) echo trixie ;;
ubuntu-2204) echo jammy ;;
ubuntu-2404) echo noble ;;
ubuntu-2604) echo resolute ;;
*) echo "Unknown Debian build name: $1" >&2; exit 1 ;;
esac
}
for DIR in artefacts/pgadmin4-deb-build-output-*; do
[ -d "${DIR}" ] || continue
CODENAME=$(codename_for "${DIR##*-output-}")
for DEB in "${DIR}"/*.deb; do
ARCH=$(basename "${DEB}" .deb); ARCH=${ARCH##*_}
TARGET="${STAGE}/apt/${CODENAME}/dists/pgadmin4/main/binary-${ARCH}"
mkdir -p "${TARGET}"
cp "${DEB}" "${TARGET}/"
done
done
# RPM trees are named for the distribution, which the build name
# already carries: el-9 becomes redhat/rhel-9-x86_64.
for DIR in artefacts/pgadmin4-rpm-build-output-*; do
[ -d "${DIR}" ] || continue
NAME=${DIR##*-output-}
case "${NAME}" in
el-*) FAMILY=redhat; TREE="rhel-${NAME#el-}" ;;
fedora-*) FAMILY=fedora; TREE="${NAME}" ;;
*) echo "Unknown RPM build name: ${NAME}" >&2; exit 1 ;;
esac
# Every RPM for a distribution goes in that distribution's
# tree, including the noarch ones. Taking the directory from the
# package's own architecture would file pgadmin4 and
# pgadmin4-web, both noarch, under rhel-9-noarch, where no
# client looks: dnf asks for <name>-<version>-$basearch. The
# RPM matrix is x86_64 only for now, so this is a constant; when
# aarch64 arrives it becomes a property of the build.
TARGET="${STAGE}/yum/${FAMILY}/${TREE}-x86_64"
mkdir -p "${TARGET}"
cp "${DIR}"/*.rpm "${TARGET}/"
done
copy_into "${STAGE}" artefacts/pgadmin4-tarball-build-output/*
copy_into "${STAGE}" artefacts/pgadmin4-python-build-output/*
# The version is read once here and used for the documentation
# filenames, which the build leaves unversioned as pgadmin4.pdf and
# pgAdmin4.epub whilst the download site has always carried
# pgadmin4-<version>.pdf and .epub.
VERSION=$(python3 -c "import sys; sys.path.insert(0, 'web'); import version; print(version.APP_VERSION)")
for SRC in artefacts/pgadmin4-pdf-build-output/*.pdf; do
[ -e "${SRC}" ] && cp "${SRC}" "${STAGE}/pgadmin4-${VERSION}.pdf"
done
for SRC in artefacts/pgadmin4-epub-build-output/*.epub; do
[ -e "${SRC}" ] && cp "${SRC}" "${STAGE}/pgadmin4-${VERSION}.epub"
done
# The docs tarball is what load-docs.sh unpacks on the web server, so
# it ships as a tarball rather than as the directory of files the
# build produces.
if [ -d artefacts/pgadmin4-html-build-output ]; then
# Under a pgadmin4-<version>-docs/ directory, not flat. The
# web server's load-docs.sh unpacks this into the docs root
# and then hands docloader that directory name, so a flat
# archive would scatter several hundred files across the root
# and then fail on a directory that does not exist. Every
# released tarball has carried that top level; the tar here
# had not.
DOCS_DIR="pgadmin4-${VERSION}-docs"
rm -rf "artefacts/${DOCS_DIR}"
mv artefacts/pgadmin4-html-build-output "artefacts/${DOCS_DIR}"
tar -czf "${STAGE}/pgadmin4-${VERSION}-docs.tar.gz" \
-C artefacts "${DOCS_DIR}"
fi
# At the root of yum/, beside the family directories, which is
# where the README instructions tell people to fetch them from.
copy_into "${STAGE}/yum" artefacts/pgadmin4-repo-rpm-build-output/*
copy_into "${STAGE}" artefacts/pgadmin4-macos-snapshot-*/*
copy_into "${STAGE}" artefacts/pgadmin4-windows-snapshot/*
find "${STAGE}" -type f | sort
- name: Check the keys are present
# A scheduled run always publishes, that being the entire point of the
# nightly; the input exists so that a dispatched test run does not.
# It has to be spelled out because a schedule event carries no inputs
# at all, so `inputs.publish` is null rather than false, and the two
# publishing steps were quietly skipped on every nightly.
if: ${{ github.event_name == 'schedule' || inputs.publish }}
env:
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
UPLOAD_KEY: ${{ vars.UPLOAD_SSH_KEY || '~/.ssh/pga-upload' }}
run: |
set -euo pipefail
for TOOL in ssh rsync; do
command -v "${TOOL}" >/dev/null || {
echo "This runner has no ${TOOL}." >&2; exit 1; }
done
# These three variables reach option positions. The target is the
# first positional argument to ssh, and the key paths are spliced
# into the -e string that rsync splits on whitespace before exec'ing
# it, so a value beginning with a hyphen, or one carrying a space,
# would be read as an option or as a second word rather than as the
# host or the path it is meant to be. Only an administrator can set
# a repository variable, which makes this defence in depth rather
# than a live hole, but it is checked here, once, rather than at
# each point of use; the -- in the publish step below closes the
# same gap from the other end.
TARGET_RE='^[A-Za-z0-9][A-Za-z0-9._-]*(@[A-Za-z0-9][A-Za-z0-9.-]*)?$'
printf '%s' "${DOWNLOAD}" | grep -Eq "${TARGET_RE}" || {
echo "DOWNLOAD_SSH_TARGET is not a [user@]host." >&2; exit 1; }
for KEY in "${PUBLISH_KEY/#\~/$HOME}" "${UPLOAD_KEY/#\~/$HOME}"; do
printf '%s' "${KEY}" | grep -Eq '^/[A-Za-z0-9._/-]+$' || {
echo "Not a plain absolute path: ${KEY}" >&2; exit 1; }
if [ ! -r "${KEY}" ]; then
echo "Missing or unreadable SSH key: ${KEY}" >&2
exit 1
fi
# A public key is readable too, and pointing -i at one fails
# later inside ssh with a message that does not mention which
# file was wrong. Both halves of a pair sit in the same
# directory with names one suffix apart, so this is an easy
# thing to configure wrongly and a cheap thing to catch.
if head -c 4 "${KEY}" | grep -q '^ssh-'; then
echo "${KEY} is a public key; -i needs the private one." >&2
echo "Drop the .pub suffix from the variable that names it." >&2
exit 1
fi
done
if [ ! -r ~/.ssh/known_hosts ]; then
echo "This runner has no ~/.ssh/known_hosts, so host key" >&2
echo "checking would fail. Add the servers' host keys." >&2
exit 1
fi
- name: Publish the snapshot
if: ${{ github.event_name == 'schedule' || inputs.publish }}
env:
DOWNLOAD: ${{ vars.DOWNLOAD_SSH_TARGET }}
# From the location job rather than from inputs.location, so the
# name reaching the publishing key is the one that job checked the
# shape of. The two agree today, which is exactly why it is worth
# fixing: the validation sat upstream of this step by coincidence
# rather than by construction.
LOCATION: ${{ needs.location.outputs.name }}
NAMED: ${{ needs.location.outputs.named }}
PUBLISH_KEY: ${{ vars.PUBLISH_SSH_KEY || '~/.ssh/pga-publish' }}
UPLOAD_KEY: ${{ vars.UPLOAD_SSH_KEY || '~/.ssh/pga-upload' }}
run: |
set -euo pipefail
if [ -z "${DOWNLOAD}" ]; then
echo "The DOWNLOAD_SSH_TARGET variable is not set." >&2
exit 1
fi
# One directory came out of assemble, named for the date. An explicit
# location overrides it so that a test run does not land on the
# snapshot the buildfarm is still writing on the same server.
# assemble produces exactly one directory, named for the date.
# Anything else means the artefact is not what this step thinks it
# is, and guessing which one to publish is not a decision to make at
# three in the morning.
if [ "$(find stage -mindepth 1 -maxdepth 1 -type d | wc -l)" != "1" ]; then
echo "Expected one directory in the snapshot artefact:" >&2
ls -l stage >&2
exit 1
fi
BUILT=$(basename "$(find stage -mindepth 1 -maxdepth 1 -type d)")
# An empty input still means "whatever assemble called it", which is
# why this turns on the flag rather than on the name being empty:
# the location job fills a blank input in with today's date, so the
# name itself no longer says whether anybody asked for one.
if [ "${NAMED}" = "yes" ]; then
DEST=${LOCATION}
else
DEST=${BUILT}
fi
echo "Publishing ${BUILT} as ${DEST}"
publish() {
ssh -i "${PUBLISH_KEY/#\~/$HOME}" -o BatchMode=yes \
-o StrictHostKeyChecking=yes -- "${DOWNLOAD}" "$@"
}
publish snapshot-create "${DEST}"
# No --delete, deliberately: rrsync refuses it anyway, and a
# publishing step that can remove things is a publishing step that
# can remove the wrong things.
rsync -rlt --safe-links --no-specials --no-devices \
-e "ssh -i ${UPLOAD_KEY/#\~/$HOME} -o BatchMode=yes -o StrictHostKeyChecking=yes" \
"stage/${BUILT}/" "${DOWNLOAD}:${DEST}/"
# Signing before indexing: the metadata has to describe the signed
# packages rather than the unsigned ones just uploaded.
publish snapshot-sign "${DEST}"
publish snapshot-index-apt "${DEST}"
publish snapshot-index-yum "${DEST}"
# Retention, which the buildfarm did with ls | tail | xargs rm. The
# verb takes no argument: it cannot be asked to remove a particular
# snapshot, only to enforce the retention the server already has.
#
# Skipped when the directory was named by hand, because that is a
# test run, and a test run has no business deciding which of the
# real snapshots are old enough to delete.
if [ "${NAMED}" = "yes" ]; then
echo "Named location, so leaving retention alone."
else
publish snapshot-purge
fi
-58
View File
@@ -1,58 +0,0 @@
# This workflow requires the following configuration in Github
#
# Variables:
# SONARQUBE_PROJECT_KEY - The project key in SonarQube
#
# Secrets:
# SONARQUBE_TOKEN - SonarQube API token
# SONARQUBE_HOST - The URL of the SonarQube host
name: SonarQube scan
on:
push:
branches: [ "master" ]
concurrency:
group: sonarqube
cancel-in-progress: false
jobs:
run-sonarqube-scan:
# Only run if the project key is set
if: vars.SONARQUBE_PROJECT_KEY != null
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Create the scan properties file
run: |
cat <<EOF > sonar-project.properties
sonar.projectKey=${{ vars.SONARQUBE_PROJECT_KEY }}
sonar.projectName=pgAdmin 4
sonar.projectVersion=%VERSION%
# Ignore templates and SQL scripts as they confuse the scanner
sonar.exclusions=**/templates/**/*, **/*.sql
# Let SonarQube know where tests can be found
sonar.test.inclusions=**/tests/**, web/regression
# Python compatibility
sonar.python.version=3.7, 3.8, 3.9, 3.10, 3.11
EOF
APP_RELEASE=`grep "^APP_RELEASE" web/config.py | cut -d"=" -f2 | sed 's/ //g'`
APP_REVISION=`grep "^APP_REVISION" web/config.py | cut -d"=" -f2 | sed 's/ //g'`
APP_LONG_VERSION=${APP_RELEASE}.${APP_REVISION}
sed -i "s/%VERSION%/${APP_LONG_VERSION}/g" sonar-project.properties
- name: SonarQube Scan
uses: sonarsource/sonarqube-scan-action@master
env:
SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
SONAR_HOST_URL: ${{ secrets.SONARQUBE_HOST }}
+341
View File
@@ -0,0 +1,341 @@
# Contributing to pgAdmin 4
Thank you for your interest in contributing to pgAdmin 4.
## Contents
- Getting Started
- Reporting Issues
- Making Changes
- Pull Requests
- AI-assisted Contributions
- Development Setup
- Database Migrations
- Security Issues
- Community and Support
- License
## Getting Started
Before starting work, please review the project documentation and familiarize yourself with the architecture and development workflow.
### Architecture
pgAdmin 4 is written as a web application with Python (Flask) on the server side and ReactJS, HTML5 with CSS for the client side processing and UI.
Although developed using web technologies, pgAdmin 4 can be deployed either on a web server using a browser, or standalone on a workstation. The [runtime/](runtime/) subdirectory contains an Electron-based runtime application intended to allow this, which will fork a Python server process and display the UI.
For a fuller introduction to the codebase, see the [code overview](docs/en_US/code_overview.rst).
If you are new to the codebase, consider starting with smaller bug fixes or documentation improvements before working on larger changes.
The Sphinx documentation also includes contributor guidance for [coding standards](docs/en_US/coding_standards.rst), [submitting pull requests](docs/en_US/submitting_pull_requests.rst), [code review](docs/en_US/code_review.rst), and [translations](docs/en_US/translations.rst).
## Reporting Issues
When reporting a bug:
- Search existing issues first.
- If a similar issue exists, add any additional information or context you have. Do not create a duplicate issue.
- Provide clear steps to reproduce the issue.
- Include relevant environment and version information.
- Attach screenshots, logs, or error messages when appropriate.
For feature requests, describe the problem being solved and the expected behavior.
## Making Changes
When working on a contribution:
- Keep changes focused and easy to review.
- Follow existing coding patterns and conventions, including the [coding standards](docs/en_US/coding_standards.rst).
- Avoid unrelated refactoring and changes in the same commit.
- Keep commit messages clear and descriptive.
- Update tests or documentation when necessary.
## Pull Requests
Before opening a pull request:
- Ensure your changes build successfully.
- Test your changes locally.
- Review your code before submission.
- Update your branch with the latest changes from `master` upstream when appropriate.
When opening a pull request:
- Clearly describe the change.
- Explain the reason for the change.
- Include screenshots or recordings for UI-related changes when applicable.
- Submit any changes as Pull Requests against the `master` branch of the [pgadmin-org/pgadmin4](https://github.com/pgadmin-org/pgadmin4) repository.
Use a clear pull request title that describes the change. Short prefixes such as `feat:`, `fix:`, `docs:`, `test:`, `refactor:`, and `chore:` are useful when they match the change being made. Branch names are contributor-local and do not need to follow a project-specific naming convention.
For more detail, see the [pull request submission guide](docs/en_US/submitting_pull_requests.rst) and [code review guide](docs/en_US/code_review.rst).
## AI-assisted Contributions
Contributors are responsible for understanding, testing, and standing behind everything they submit, whether or not AI tools were used. Please do not open large numbers of auto-generated issues or pull requests without first discussing that work with the maintainers.
## Development Setup
In the following documentation and examples, `$PGADMIN4_SRC` is used to denote the top-level directory of your copy of the pgAdmin source tree (either from a tarball or a git checkout).
### Prerequisites
1. Install Node.js 20 and above (https://nodejs.org/en/download)
2. yarn (https://yarnpkg.com/getting-started/install)
3. Python 3.9 and above (https://www.python.org/downloads/)
4. PostgreSQL server (https://www.postgresql.org/download)
Start by enabling Corepack, if it isn't already; this will add the yarn binary to your PATH:
```bash
corepack enable
```
### Building Web Assets
pgAdmin is dependent on a number of third-party JavaScript libraries. These, along with its own JavaScript code, CSS code and images must be compiled into a "bundle" which is transferred to the browser for execution and rendering. This is far more efficient than simply requesting each asset as it is needed by the client.
To create the bundle, you will need the 'yarn' package management tool to be installed. Then, you can run the following commands on a *nix system to download the required packages and build the bundle:
```bash
$ cd $PGADMIN4_SRC
$ make install-node
$ make bundle
```
On Windows systems (where "make" is not available), the following commands can be used:
```bat
C:\> cd $PGADMIN4_SRC\web
C:\$PGADMIN4_SRC\web> yarn install
C:\$PGADMIN4_SRC\web> yarn run bundle
```
### Python Environment
In order to run the Python code, a suitable runtime environment is required. Python version 3.9 and later are currently supported. It is recommended that a Python virtual environment is set up for this purpose, rather than using the system Python environment. On Linux and Mac systems, the process is fairly simple - adapt as required for your distribution:
1. Create a virtual environment in an appropriate directory. The last argument is the name of the environment; that can be changed as desired:
```bash
$ python3 -m venv venv
```
2. Now activate the virtual environment:
```bash
$ source venv/bin/activate
```
On Windows:
```bash
venv\Scripts\activate
```
3. Some of the components used by pgAdmin require a very recent version of *pip*, so update that to the latest:
```bash
(venv) $ pip install --upgrade pip
```
4. Ensure that a PostgreSQL installation's bin/ directory is in the path (so pg_config can be found for building psycopg3), and install the required packages:
```bash
(venv) $ PATH=$PATH:/usr/local/pgsql/bin pip install -r $PGADMIN4_SRC/requirements.txt
```
If you are planning to run the regression tests, you also need to install additional requirements from `web/regression/requirements.txt`:
```bash
(venv) $ pip install -r $PGADMIN4_SRC/web/regression/requirements.txt
```
### Configuration
Create a local configuration file for pgAdmin. Edit `$PGADMIN4_SRC/web/config_local.py` and add any desired configuration options (use the `config.py` file as a reference - any settings duplicated in `config_local.py` will override those in `config.py`). A typical development configuration may look like:
```python
import os
import logging
# Change pgAdmin data directory
DATA_DIR = '/Users/myuser/.pgadmin_dev'
# Change pgAdmin server and port
DEFAULT_SERVER = '127.0.0.1'
DEFAULT_SERVER_PORT = 5051
# Switch between server and desktop mode
SERVER_MODE = True
# Change pgAdmin config DB path in case an external DB is used.
CONFIG_DATABASE_URI="postgresql://postgres:postgres@localhost:5436/pgadmin"
# Set up SMTP
MAIL_SERVER = 'smtp.gmail.com'
MAIL_PORT = 465
MAIL_USE_SSL = True
MAIL_USERNAME = 'user@gmail.com'
MAIL_PASSWORD = 'xxxxxxxxxx'
# Change log level
CONSOLE_LOG_LEVEL = logging.INFO
FILE_LOG_LEVEL = logging.INFO
# Use a different config DB for each server mode.
if SERVER_MODE == False:
SQLITE_PATH = os.path.join(
DATA_DIR,
'pgadmin4-desktop.db'
)
else:
SQLITE_PATH = os.path.join(
DATA_DIR,
'pgadmin4-server.db'
)
```
This configuration allows easy switching between server and desktop modes for testing.
### Running pgAdmin
The initial setup of the configuration database is interactive in server mode, and non-interactive in desktop mode. You can run it either by running:
```bash
(venv) $ python3 $PGADMIN4_SRC/web/setup.py
```
or by starting pgAdmin 4:
```bash
(venv) $ python3 $PGADMIN4_SRC/web/pgAdmin4.py
```
Whilst it is possible to automatically run setup in desktop mode by running the runtime, that will not work in server mode as the runtime doesn't allow command line interaction with the setup program.
At this point you will be able to run pgAdmin 4 from the command line in either server or desktop mode, and access it from a web browser using the URL shown in the terminal once pgAdmin has started up.
Setup of an environment on Windows is somewhat more complicated unfortunately, please see `pkg/win32/README.md` for complete details.
### Building the documentation
In order to build the docs, an additional Python package is required in the virtual environment. This can be installed with the pip package manager:
```bash
$ source venv/bin/activate
(venv) $ pip install Sphinx
(venv) $ pip install sphinxcontrib-youtube
```
The docs can then be built using the Makefile in `$PGADMIN4_SRC`, e.g.
```bash
(venv) $ make docs
```
The output can be found in `$PGADMIN4_SRC/docs/en_US/_build/html/index.html`
### Runtime Development
For Electron runtime development:
1. Navigate to the `runtime` directory.
2. Install dependencies:
```bash
yarn install
```
3. Copy:
```text
dev_config.json.in
```
to:
```text
dev_config.json
```
4. Update the paths to your Python executable and `pgAdmin4.py`.
Start the runtime:
```bash
yarn run start
```
### Building packages
Most packages can be built using the Makefile in `$PGADMIN4_SRC`, provided all the setup and configuration above has been completed.
To build a source tarball:
```bash
(venv) $ make src
```
To build a PIP Wheel, activate either a Python 3 virtual environment, configured with all the required packages, and then run:
```bash
(venv) $ make pip
```
To build the macOS AppBundle, please see `pkg/mac/README.md`.
To build the Windows installer, please see `pkg/win32/README.md`.
## Database Migrations
In order to make changes to the SQLite DB, navigate to the 'web' directory:
```bash
(venv) $ cd $PGADMIN4_SRC/web
```
Create a migration file with the following command:
```bash
(venv) $ FLASK_APP=pgAdmin4.py flask db revision
```
This will create a file in `$PGADMIN4_SRC/web/migrations/versions/`. Add any changes to the `upgrade` function.
When making schema changes, update the `SCHEMA_VERSION` value in:
```text
web/pgadmin/model/__init__.py
```
There is no need to increment the `SETTINGS_SCHEMA_VERSION`.
## Security Issues
**Do not report security vulnerabilities through GitHub issues.**
Potential security issues should be reported to:
`security@pgadmin.org`.
Note that this **address should only be used for reporting security issues** that you believe you've found in the design or code of pgAdmin, pgAgent, and the pgAdmin website. It **should not be used to ask security questions**.
If you are unsure whether an issue is a security vulnerability, please lean on the side of caution and report it to the above address. The pgAdmin team will review the report and respond as appropriate.
## Community and Support
For development discussions, use:
`pgadmin-hackers@postgresql.org`
For support options, visit the [pgAdmin support page](https://www.pgadmin.org/support/).
Use the [GitHub issue tracker](https://github.com/pgadmin-org/pgadmin4/issues) for reporting bugs and requesting features, but please follow the guidelines outlined in the "Reporting Issues" section above.
## License
By contributing to pgAdmin 4, you agree that your contributions will be licensed under the project's existing and future license terms.
+16 -4
View File
@@ -42,9 +42,7 @@ RUN --mount=type=bind,source=.git,target=/pgadmin4/.git \
export CPPFLAGS="-DPNG_ARM_NEON_OPT=0" && \
npm install -g corepack && \
corepack enable && \
yarn set version berry && \
yarn set version 4 && \
yarn install && \
yarn install --immutable && \
yarn run bundle && \
rm -rf yarn.lock \
package.json \
@@ -61,8 +59,15 @@ RUN --mount=type=bind,source=.git,target=/pgadmin4/.git \
FROM python:3-alpine AS env-builder
# Install dependencies
#
# libpq is a runtime dependency of psycopg's C extension: psycopg[c] is built
# from source against postgresql-dev, but that is removed with build-deps
# below, so libpq.so.5 must be installed separately to survive. Without it,
# importing psycopg (which the Sphinx docs build does, via config.py) fails
# with "no pq wrapper available".
RUN apk add --no-cache \
make && \
make \
libpq && \
apk add --no-cache --virtual build-deps \
build-base \
openssl-dev \
@@ -79,6 +84,13 @@ RUN python3 -m venv --system-site-packages --without-pip /venv && \
/venv/bin/python3 -m pip install --no-cache-dir -r requirements.txt && \
apk del --no-cache build-deps
# Remove the files pgAdmin never uses. The script reads the language list from
# web/config.py, so it is copied in separately to avoid a change to it
# reinstalling the requirements above.
COPY pkg/prune_site_packages.py /prune/pkg/
COPY web/config.py /prune/web/
RUN /venv/bin/python3 /prune/pkg/prune_site_packages.py /venv
#########################################################################
# Now, create a documentation build container for the Sphinx docs
#########################################################################
+285 -92
View File
@@ -20,12 +20,18 @@ IF "%1" == "clean" (
)
REM Main build sequence
REM
REM The clean runs first because :FETCH_PYTHON unpacks into the temp directory
REM that it removes, and the fetch runs before :SET_ENVIRONMENT because the
REM latter has no interpreter of its own to ask about the build.
CALL :CLEAN || EXIT /B 1
CALL :FETCH_PYTHON || EXIT /B 1
CALL :SET_ENVIRONMENT
CALL :VALIDATE_ENVIRONMENT || EXIT /B 1
CALL :CLEAN || EXIT /B 1
CALL :CREATE_VIRTUAL_ENV || EXIT /B 1
CALL :CREATE_PYTHON_ENV || EXIT /B 1
CALL :CREATE_RUNTIME_ENV || EXIT /B 1
CALL :SIGN_COMPONENTS || EXIT /B 1
CALL :GENERATE_SBOM || EXIT /B 1
CALL :CREATE_INSTALLER || EXIT /B 1
CALL :VERIFY_SIGNATURE || EXIT /B 1
@@ -50,15 +56,78 @@ REM Main build sequence Ends
EXIT /B 0
:FETCH_PYTHON
REM Fetch the Python this build uses, rather than using whatever happens to
REM be installed on the machine running it. Which interpreter pgAdmin ships
REM is a decision recorded in pkg\python-version.txt, not a property of the
REM build agent, and this is the only place on Windows that reads it.
REM
REM The distribution comes from astral-sh/python-build-standalone: it is
REM relocatable, published per exact CPython version, and is a plain tarball
REM rather than an installer, so unpacking it raises no UAC prompt. That
REM matters on the signing host, where the desktop session is logged in
REM automatically and an elevation dialog waits forever for somebody who is
REM not there.
REM
REM curl.exe and tar.exe have shipped in Windows since 1803, so this needs
REM nothing installed to bootstrap itself, not even a Python.
ECHO Reading the Python version...
SET "PYTHON_VERSION="
SET "PYTHON_BUILD_STANDALONE_TAG="
FOR /F "eol=# usebackq tokens=1,2 delims==" %%a IN ("%WD%\pkg\python-version.txt") DO (
IF "%%a" == "PYTHON_VERSION" SET "PYTHON_VERSION=%%b"
IF "%%a" == "PYTHON_BUILD_STANDALONE_TAG" SET "PYTHON_BUILD_STANDALONE_TAG=%%b"
)
IF "%PYTHON_VERSION%" == "" (
ECHO PYTHON_VERSION is not set in pkg\python-version.txt.
EXIT /B 1
)
IF "%PYTHON_BUILD_STANDALONE_TAG%" == "" (
ECHO PYTHON_BUILD_STANDALONE_TAG is not set in pkg\python-version.txt.
EXIT /B 1
)
REM Split for the runtime build, where e.g. 3.13.15 becomes 313
FOR /F "tokens=1,2,3 delims=." %%a IN ("%PYTHON_VERSION%") DO (
SET "PYTHON_MAJOR=%%a"
SET "PYTHON_MINOR=%%b"
SET "PYTHON_REVISION=%%c"
)
SET "PGADMIN_PYTHON_DIR=%TMPDIR%\python"
SET "PYTHON_ARCHIVE=cpython-%PYTHON_VERSION%+%PYTHON_BUILD_STANDALONE_TAG%-x86_64-pc-windows-msvc-install_only.tar.gz"
IF NOT EXIST "%TMPDIR%" MKDIR "%TMPDIR%"
ECHO Downloading Python %PYTHON_VERSION%...
curl.exe --fail --location --silent --show-error --output "%TMPDIR%\python.tar.gz" "https://github.com/astral-sh/python-build-standalone/releases/download/%PYTHON_BUILD_STANDALONE_TAG%/%PYTHON_ARCHIVE%" || EXIT /B 1
ECHO Unpacking Python...
REM The archive unpacks to a single python\ directory.
tar -x -f "%TMPDIR%\python.tar.gz" -C "%TMPDIR%" || EXIT /B 1
DEL /q "%TMPDIR%\python.tar.gz" > nul 2>&1
"%PGADMIN_PYTHON_DIR%\python.exe" --version || EXIT /B 1
REM :CREATE_VIRTUAL_ENV needs virtualenv rather than the venv module, as it
REM relocates the result. pip is bundled with the distribution, but ask
REM ensurepip for it anyway so this does not quietly depend on that.
ECHO Installing virtualenv...
"%PGADMIN_PYTHON_DIR%\python.exe" -m ensurepip --upgrade || EXIT /B 1
"%PGADMIN_PYTHON_DIR%\python.exe" -m pip install --upgrade pip virtualenv || EXIT /B 1
EXIT /B 0
:SET_ENVIRONMENT
ECHO Configuring the environment...
IF "%PGADMIN_PYTHON_DIR%" == "" SET "PGADMIN_PYTHON_DIR=C:\Python313"
IF "%PGADMIN_KRB5_DIR%" == "" SET "PGADMIN_KRB5_DIR=C:\Program Files\MIT\Kerberos"
IF "%PGADMIN_POSTGRES_DIR%" == "" SET "PGADMIN_POSTGRES_DIR=C:\Program Files\PostgreSQL\17"
IF "%PGADMIN_KRB5_DIR%" == "" SET "PGADMIN_KRB5_DIR=C:\build64\krb5"
IF "%PGADMIN_POSTGRES_DIR%" == "" SET "PGADMIN_POSTGRES_DIR=C:\build64\postgresql"
IF "%PGADMIN_INNOTOOL_DIR%" == "" SET "PGADMIN_INNOTOOL_DIR=C:\Program Files (x86)\Inno Setup 6"
IF "%PGADMIN_VCREDIST_DIR%" == "" SET "PGADMIN_VCREDIST_DIR=C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Redist\MSVC\14.40.33807"
IF "%PGADMIN_VCREDIST_FILE%" == "" SET "PGADMIN_VCREDIST_FILE=vc_redist.x64.exe"
IF "%PGADMIN_SIGNTOOL_DIR%" == "" SET "PGADMIN_SIGNTOOL_DIR=C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64"
IF "%PGADMIN_SIGNTOOL_DIR%" == "" SET "PGADMIN_SIGNTOOL_DIR=C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64"
IF "%PGADMIN_WINDOWS_CSC%" == "" SET "PGADMIN_WINDOWS_CSC="
REM Set additional variables we need
@@ -74,11 +143,6 @@ REM Main build sequence Ends
SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-%APP_VERSION_SUFFIX%-x64.exe
IF "%APP_VERSION_SUFFIX%" == "" SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-x64.exe
REM get Python version for the runtime build ex. 3.9.2 will be 39
FOR /f "tokens=1 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MAJOR=%%G
FOR /f "tokens=2 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MINOR=%%G
FOR /f "tokens=3 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_REVISION=%%G
EXIT /B 0
@@ -90,8 +154,8 @@ REM Main build sequence Ends
ECHO Output directory: %DISTROOT%
ECHO Installer name: %INSTALLERNAME%
ECHO.
ECHO Python directory: %PGADMIN_PYTHON_DIR%
ECHO Python version: %PYTHON_MAJOR%.%PYTHON_MINOR%.%PYTHON_REVISION%
ECHO Python directory: %PGADMIN_PYTHON_DIR%
ECHO.
ECHO KRB5 directory: %PGADMIN_KRB5_DIR%
ECHO PostgreSQL directory: %PGADMIN_POSTGRES_DIR%
@@ -113,41 +177,16 @@ REM Main build sequence Ends
ECHO ****************************************************************
ECHO Checking the environment...
IF NOT EXIST "%PGADMIN_INNOTOOL_DIR%" (
ECHO !PGADMIN_INNOTOOL_DIR! does not exist
ECHO Please install InnoTool and set the PGADMIN_INNOTOOL_DIR environment variable.
EXIT /B 1
)
IF NOT EXIST "%PGADMIN_VCREDIST_DIR%" (
ECHO !PGADMIN_VCREDIST_DIR! does not exist
ECHO Please install Microsoft Visual studio and set the PGADMIN_VCREDIST_DIR environment variable.
EXIT /B 1
)
IF NOT EXIST "%PGADMIN_KRB5_DIR%" (
ECHO !PGADMIN_KRB5_DIR! does not exist.
ECHO Please install MIT Kerberos for Windows and set the PGADMIN_KRB5_DIR environment variable.
EXIT /B 1
)
IF NOT EXIST "%PGADMIN_PYTHON_DIR%" (
ECHO !PGADMIN_PYTHON_DIR! does not exist.
ECHO Please install Python and set the PGADMIN_PYTHON_DIR environment variable.
EXIT /B 1
)
IF NOT EXIST "%PGADMIN_POSTGRES_DIR%" (
ECHO !PGADMIN_POSTGRES_DIR! does not exist.
ECHO Please install PostgreSQL and set the PGADMIN_POSTGRES_DIR environment variable.
EXIT /B 1
)
IF NOT EXIST "%PGADMIN_PYTHON_DIR%\Scripts\virtualenv.exe" (
ECHO !PGADMIN_PYTHON_DIR!\Scripts\virtualenv.exe does not exist.
ECHO Please install the virtualenv package in Python.
EXIT /B 1
)
REM The checks are made by :REQUIRE_DIR rather than inline, because the
REM message names the directory that was looked for, and a default such as
REM "C:\Program Files (x86)\Inno Setup 6" carries a closing parenthesis.
REM Inside a parenthesised block that parenthesis ends the block, as cmd
REM expands the variable when it parses the block rather than when it runs it,
REM so the block failed to parse whether or not the directory was there.
CALL :REQUIRE_DIR "%PGADMIN_INNOTOOL_DIR%" "Please install InnoTool and set the PGADMIN_INNOTOOL_DIR environment variable." || EXIT /B 1
CALL :REQUIRE_DIR "%PGADMIN_VCREDIST_DIR%" "Please install Microsoft Visual Studio and set the PGADMIN_VCREDIST_DIR environment variable." || EXIT /B 1
CALL :REQUIRE_DIR "%PGADMIN_KRB5_DIR%" "Please install MIT Kerberos for Windows, from the winpgbuild project or elsewhere, and set the PGADMIN_KRB5_DIR environment variable." || EXIT /B 1
CALL :REQUIRE_DIR "%PGADMIN_POSTGRES_DIR%" "Please install PostgreSQL, from the winpgbuild project or elsewhere, and set the PGADMIN_POSTGRES_DIR environment variable." || EXIT /B 1
SET "PATH=%PGADMIN_POSTGRES_DIR%\bin;%PATH%"
@@ -161,10 +200,14 @@ REM Main build sequence Ends
CD "%TMPDIR%"
REM Note that we must use virtualenv.exe here, as the venv module doesn't allow python.exe to relocate.
"%PGADMIN_PYTHON_DIR%\Scripts\virtualenv.exe" venv
"%PGADMIN_PYTHON_DIR%\Scripts\virtualenv.exe" venv || EXIT /B 1
XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\DLLs" "%TMPDIR%\venv\DLLs" > nul || EXIT /B 1
XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\Lib" "%TMPDIR%\venv\Lib" > nul || EXIT /B 1
REM Copy the standard library, but NOT site-packages: the venv already has its
REM own seeded pip there, and overwriting only the files the system Python also
REM has leaves a mix of two pip versions behind.
ROBOCOPY /E /R:3 /W:5 /NFL /NDL /NP "%PGADMIN_PYTHON_DIR%\Lib" "%TMPDIR%\venv\Lib" /XD site-packages
CALL :CHECK_ROBOCOPY_ERROR || EXIT /B 1
ECHO Activating virtual environment - %TMPDIR%\venv...
CALL "%TMPDIR%\venv\Scripts\activate" || EXIT /B 1
@@ -181,24 +224,29 @@ REM Main build sequence Ends
ECHO Staging Python...
MKDIR "%BUILDROOT%\python\Lib" || EXIT /B 1
ECHO Downloading embedded Python...
REM Get the python embeddable and extract it to %BUILDROOT%\python
CD "%TMPDIR%
%PGADMIN_PYTHON_DIR%\python -c "import sys; from urllib.request import urlretrieve; urlretrieve('https://www.python.org/ftp/python/' + sys.version.split(' ')[0] + '/python-' + sys.version.split(' ')[0] + '-embed-amd64.zip', 'python-embedded.zip')" || EXIT /B 1
%PGADMIN_PYTHON_DIR%\python -c "import zipfile; z = zipfile.ZipFile('python-embedded.zip', 'r'); z.extractall('../win-build/python/')" || EXIT /B 1
ECHO Downloading embedded Python %PYTHON_VERSION%...
REM What ships is the embeddable distribution from python.org, a different
REM build from the one :FETCH_PYTHON downloaded, and it has to be the same
REM CPython version: the extension modules in site-packages were compiled
REM against the build Python and are about to be run under this one. Both
REM therefore read pkg\python-version.txt, rather than either asking the
REM other what it is.
curl.exe --fail --location --silent --show-error --output "%TMPDIR%\python-embedded.zip" "https://www.python.org/ftp/python/%PYTHON_VERSION%/python-%PYTHON_VERSION%-embed-amd64.zip" || EXIT /B 1
tar -x -f "%TMPDIR%\python-embedded.zip" -C "%BUILDROOT%\python" || EXIT /B 1
ECHO Copying site-packages...
XCOPY /S /I /E /H /Y "%TMPDIR%\venv\Lib\site-packages" "%BUILDROOT%\python\Lib\site-packages" > nul || EXIT /B 1
REM This is done to the copy rather than the venv, which still needs pip to
REM install Sphinx for the docs in :CREATE_RUNTIME_ENV.
ECHO Removing unused files from the installed packages...
"%TMPDIR%\venv\Scripts\python.exe" "%WD%\pkg\prune_site_packages.py" "%BUILDROOT%\python\Lib\site-packages" || EXIT /B 1
REM NOTE: There is intentionally no space after "site" in the line below, to prevent Python barfing if there's one in the file
ECHO import site>> "%BUILDROOT%\python\python%PYTHON_MAJOR%%PYTHON_MINOR%._pth"
ECHO Staging Kerberos components...
COPY "%PGADMIN_KRB5_DIR%\bin\kinit.exe" "%BUILDROOT%\python" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\krb5_64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\comerr64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\k5sprt64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\gssapi64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
REM NOTE: The Kerberos components are staged into the runtime directory
REM alongside libpq.dll, not here. See :CREATE_RUNTIME_ENV.
ECHO Cleaning up unnecessary .pyc and .pyo files...
FOR /R "%BUILDROOT%\python" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
@@ -216,14 +264,19 @@ REM Main build sequence Ends
RD /Q /S "%WD%\web\pgadmin\static\js\generated\.cache" 1> nul 2>&1
ECHO Copying web directory...
ROBOCOPY /S "%WD%\web" "%BUILDROOT%\web" > nul
CALL :CHECK_ROBOCOPY_ERROR
ROBOCOPY /S /NFL /NDL /NP "%WD%\web" "%BUILDROOT%\web"
CALL :CHECK_ROBOCOPY_ERROR || EXIT /B 1
ECHO Installing javascript dependencies...
CD "%BUILDROOT%\web"
CALL yarn set version berry || EXIT /B 1
CALL yarn set version 4 || EXIT /B 1
CALL yarn install || EXIT /B 1
SET "YARN_VERSION="
FOR /f "delims=" %%v IN ('node -p "require('./package.json').packageManager.split('@')[1]"') DO SET "YARN_VERSION=%%v"
IF "%YARN_VERSION%"=="" (
ECHO ERROR: Could not determine Yarn version from package.json packageManager field.
EXIT /B 1
)
CALL yarn set version %YARN_VERSION% || EXIT /B 1
CALL yarn install --immutable || EXIT /B 1
CALL npm rebuild || EXIT /B 1
ECHO Bundling javascript...
@@ -237,8 +290,18 @@ REM Main build sequence Ends
RD /Q /S "%BUILDROOT%\web\regression" 1> nul 2>&1
ECHO Removing tools...
RD /Q /S "%BUILDROOT%\web\tools" 1> nul 2>&1
ECHO Removing yarn cache...
ECHO Removing the JavaScript build configuration...
RD /Q /S "%BUILDROOT%\web\.yarn" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\yarn.lock" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\.yarnrc.yml" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\package.json" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\jest.config.js" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\babel.cfg" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\babel.config.json" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\webpack.config.js" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\webpack.shim.js" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\.eslintrc.js" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\.editorconfig" 1> nul 2>&1
ECHO Removing any existing configurations...
DEL /q "%BUILDROOT%\web\pgadmin4.db" 1> nul 2>&1
DEL /q "%BUILDROOT%\web\config_local.py" 1> nul 2>&1
@@ -276,8 +339,13 @@ REM Main build sequence Ends
CD "%BUILDROOT%\runtime\resources\app\"
CALL yarn set version berry || EXIT /B 1
CALL yarn set version 4 || EXIT /B 1
SET "YARN_VERSION="
FOR /f "delims=" %%v IN ('node -p "require('./package.json').packageManager.split('@')[1]"') DO SET "YARN_VERSION=%%v"
IF "%YARN_VERSION%"=="" (
ECHO ERROR: Could not determine Yarn version from package.json packageManager field.
EXIT /B 1
)
CALL yarn set version %YARN_VERSION% || EXIT /B 1
CALL yarn workspaces focus --production || EXIT /B 1
ECHO Removing yarn cache...
@@ -286,9 +354,33 @@ REM Main build sequence Ends
ECHO Downloading Electron to %TMPDIR%...
REM Get a fresh copy of electron.
REM WGET
FOR /f "tokens=*" %%i IN ('npm info electron version') DO SET "ELECTRON_VERSION=%%i"
REM Resolve the electron version from runtime\yarn.lock, NOT from the npm
REM registry and NOT from the range in runtime\package.json. The registry's
REM `latest` dist-tag lands any newly published electron release in shipped
REM binaries without review, whilst the package.json range is only a lower
REM bound, so yarn is free to resolve it to a build other than the one we
REM ship. The lockfile is the single source of truth, and `yarn info`
REM reports its resolution without touching the network or needing
REM node_modules.
REM
REM It must run inside runtime\ though: outside a yarn project, `yarn info`
REM silently falls back to querying the registry and still exits 0, so check
REM the lockfile is present first and validate what comes back.
IF NOT EXIST "%WD%\runtime\yarn.lock" (
ECHO ERROR: "%WD%\runtime\yarn.lock" not found; cannot resolve the pinned Electron version.
EXIT /B 1
)
SET "ELECTRON_VERSION="
PUSHD "%WD%\runtime" || EXIT /B 1
FOR /f "delims=" %%i IN ('yarn info electron --json ^| node -e "const lines=require('fs').readFileSync(0,'utf8').split('\n').filter(Boolean);const pkg=lines.map(l=>{try{return JSON.parse(l);}catch(e){return null;}}).find(o=>o&&typeof o.value==='string'&&o.value.startsWith('electron@npm:'));const version=(pkg&&pkg.children&&pkg.children.Version)||'';process.stdout.write(/^[0-9]+[.][0-9]+[.][0-9]+(-[0-9A-Za-z.-]+)?$/.test(version)?version:'');"') DO SET "ELECTRON_VERSION=%%i"
POPD
IF "%ELECTRON_VERSION%"=="" (
ECHO ERROR: Could not resolve the pinned Electron version from "%WD%\runtime\yarn.lock".
EXIT /B 1
)
REM WGET
:GET_NW
wget https://github.com/electron/electron/releases/download/v%ELECTRON_VERSION%/electron-v%ELECTRON_VERSION%-win32-x64.zip -O "%TMPDIR%\electron-v%ELECTRON_VERSION%-win32-x64.zip"
IF %ERRORLEVEL% NEQ 0 GOTO GET_NW
@@ -310,36 +402,51 @@ REM Main build sequence Ends
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-icon "%WD%\pkg\win32\Resources\pgAdmin4.ico"
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-version-string "FileDescription" "%APP_NAME%"
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-version-string "ProductName" "%APP_NAME%"
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-product-version "%APP_VERSION%""
IF NOT "%PGADMIN_WINDOWS_CSC%" == "" (
ECHO Attempting to sign the pgAdmin4.exe...
CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" sign /sm /n "%PGADMIN_WINDOWS_CSC%" /tr http://timestamp.digicert.com /td sha256 /fd sha1 /v "%BUILDROOT%\runtime\pgAdmin4.exe"
IF %ERRORLEVEL% NEQ 0 (
ECHO.
ECHO ************************************************************
ECHO * Failed to sign the pgAdmin4.exe
ECHO ************************************************************
PAUSE
)
) ELSE (
ECHO Skipping code signing ^(PGADMIN_WINDOWS_CSC is not set^)...
)
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-product-version "%APP_VERSION%"
ECHO Staging PostgreSQL components...
COPY "%PGADMIN_POSTGRES_DIR%\bin\libpq.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_POSTGRES_DIR%\bin\libcrypto-*-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_POSTGRES_DIR%\bin\libssl-*-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" "%BUILDROOT%\runtime" > nul
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" "%BUILDROOT%\runtime" > nul
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\liblz4.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\liblz4.dll" "%BUILDROOT%\runtime" > nul
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libzstd.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\libzstd.dll" "%BUILDROOT%\runtime" > nul
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" (
COPY "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
)
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" (
COPY "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
)
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\liblz4.dll" (
COPY "%PGADMIN_POSTGRES_DIR%\bin\liblz4.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
)
IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libzstd.dll" (
COPY "%PGADMIN_POSTGRES_DIR%\bin\libzstd.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
)
COPY "%PGADMIN_POSTGRES_DIR%\bin\zlib1.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_POSTGRES_DIR%\bin\pg_dump.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_POSTGRES_DIR%\bin\pg_dumpall.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1L%
COPY "%PGADMIN_POSTGRES_DIR%\bin\pg_dumpall.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_POSTGRES_DIR%\bin\pg_restore.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_POSTGRES_DIR%\bin\psql.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
REM The Kerberos runtime belongs here, next to libpq.dll and the client
REM binaries: PostgreSQL 18 and later are built with GSSAPI support, so
REM libpq.dll has a load-time dependency on gssapi64.dll, and pg_dump.exe
REM and friends resolve it from their own directory. The pgAdmin server
REM process finds it here too, because the runtime prepends this directory
REM to PATH before spawning Python.
REM
REM krb5_64.dll loads krbcc64.dll dynamically rather than importing it, but
REM it is not optional: on Windows krb5 defaults the credential cache type
REM to CCAPI, and the entry points for that are left null when the DLL
REM cannot be loaded, so the first use of the default credential cache
REM calls address zero. ccapiserver.exe is the process krbcc64.dll drives.
ECHO Staging Kerberos components...
COPY "%PGADMIN_KRB5_DIR%\bin\kinit.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\krb5_64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\comerr64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\k5sprt64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\gssapi64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\krbcc64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
COPY "%PGADMIN_KRB5_DIR%\bin\ccapiserver.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
ECHO Staging VC++ runtime...
MKDIR "%BUILDROOT%\installer" || EXIT /B 1
COPY "%PGADMIN_VCREDIST_DIR%\%PGADMIN_VCREDIST_FILE%" "%BUILDROOT%\installer" > nul || EXIT /B 1
@@ -366,8 +473,12 @@ REM Main build sequence Ends
DEL /s "%WD%\pkg\win32\installer.iss.in_stage*" > nul
ECHO Creating windows installer using INNO tool...
REM Inno signs the installer and its uninstaller itself, one file per call,
REM through the same script as :SIGN_FILES. Inno replaces $q with a quote
REM and $f with the already-quoted file name. The outer pair of quotes is
REM for cmd /c, which strips the first and last quote of its command line.
IF NOT "%PGADMIN_WINDOWS_CSC%" == "" (
CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" "%WD%\pkg\win32\installer.iss" "/SpgAdminSigntool=%PGADMIN_SIGNTOOL_DIR%\signtool.exe sign /sm /n $q%PGADMIN_WINDOWS_CSC%$q /tr http://timestamp.digicert.com /td sha256 /fd sha1 /v $f" || EXIT /B 1
CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" "%WD%\pkg\win32\installer.iss" "/DSIGNED" "/SpgAdminSigntool=%ComSpec% /c $q$q%WD%\pkg\win32\sign-files.bat$q $q%PGADMIN_WINDOWS_CSC%$q $f$q" || EXIT /B 1
) ELSE (
CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" "%WD%\pkg\win32\installer.iss" || EXIT /B 1
)
@@ -396,17 +507,86 @@ REM Main build sequence Ends
ECHO Verifying the installer signature...
CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" verify /pa /v "%DISTROOT%\%INSTALLERNAME%"
IF %ERRORLEVEL% NEQ 0 (
REM PAUSE was the old handler here, which on the signing host either returns
REM immediately, leaving the build to carry on with an unverified installer,
REM or blocks until the job times out. There is nobody at that machine to
REM press a key.
IF ERRORLEVEL 1 (
ECHO.
ECHO ************************************************************
ECHO * Failed to verify signature of the installer
ECHO ************************************************************
PAUSE
EXIT /B 1
)
EXIT /B 0
REM Sign one or more files, passed as quoted arguments, with a SHA-256 file
REM digest. pkg\win32\sign-files.bat does the work, in signtool's split
REM digest, sign and ingest steps, because the one-step form cannot use a
REM SHA-2 digest with the card's key; the script explains why. All the files
REM go in one call because each call costs one PIN prompt, and their names
REM must be unique, which the script checks.
:SIGN_FILES
IF "%PGADMIN_WINDOWS_CSC%" == "" EXIT /B 0
CALL "%WD%\pkg\win32\sign-files.bat" "%PGADMIN_WINDOWS_CSC%" %*
REM IF ERRORLEVEL, not IF %ERRORLEVEL%: the latter would be expanded before
REM the script had run were this ever moved inside a parenthesised block.
IF ERRORLEVEL 1 (
ECHO.
ECHO ************************************************************
ECHO * Failed to sign one or more files
ECHO ************************************************************
EXIT /B 1
)
EXIT /B 0
REM Sign the components that we build ourselves: the runtime executable, and
REM the PostgreSQL and Kerberos utilities and libraries obtained from the
REM winpgbuild project, all of which are staged into the runtime directory by
REM :CREATE_RUNTIME_ENV. The Electron, Python and VC++ runtime components are
REM deliberately left alone, as they are third party binaries that we do not
REM build, and signing them would replace any signature of their own. Names
REM are matched as patterns as some of the libraries include version numbers,
REM and some of them are optional.
:SIGN_COMPONENTS
IF "%PGADMIN_WINDOWS_CSC%" == "" (
ECHO Skipping code signing ^(PGADMIN_WINDOWS_CSC is not set^)...
EXIT /B 0
)
ECHO Attempting to sign the pgAdmin, PostgreSQL and Kerberos components...
SETLOCAL EnableDelayedExpansion
SET "COMPONENTS="
REM FOR expands an item containing a wildcard against the current directory
REM and silently drops it when nothing matches there, so the loop must run
REM in the runtime directory for the versioned libraries to be found at
REM all. Plain names are passed through whether or not the file exists,
REM hence the IF EXIST for the optional ones.
PUSHD "%BUILDROOT%\runtime" || EXIT /B 1
FOR %%f IN (pgAdmin4.exe libpq.dll libcrypto-*-x64.dll libssl-*-x64.dll libintl-*.dll libiconv-*.dll liblz4.dll libzstd.dll zlib1.dll pg_dump.exe pg_dumpall.exe pg_restore.exe psql.exe kinit.exe krb5_64.dll comerr64.dll k5sprt64.dll gssapi64.dll krbcc64.dll ccapiserver.exe) DO (
IF EXIST "%%f" SET "COMPONENTS=!COMPONENTS! "%BUILDROOT%\runtime\%%f""
)
POPD
IF "!COMPONENTS!" == "" (
ECHO.
ECHO ************************************************************
ECHO * No components were found to sign
ECHO ************************************************************
ENDLOCAL
EXIT /B 1
)
CALL :SIGN_FILES !COMPONENTS! || EXIT /B 1
ENDLOCAL
EXIT /B 0
:USAGE
ECHO Invalid command line options.
ECHO Usage: "Make.bat [clean]"
@@ -417,3 +597,16 @@ REM Main build sequence Ends
:CHECK_ROBOCOPY_ERROR
IF %ERRORLEVEL% GEQ 8 EXIT /B %ERRORLEVEL%
EXIT /B 0
REM Check that a prerequisite directory exists, reporting the path that was
REM looked for and how to correct it if it does not. The first argument is the
REM directory and the second the hint; both are echoed here, outside any
REM parenthesised block, so a parenthesis in either is just a character.
:REQUIRE_DIR
IF EXIST "%~1" EXIT /B 0
ECHO %~1 does not exist.
ECHO %~2
EXIT /B 1
+1 -1
View File
@@ -25,7 +25,7 @@ appbundle:
./pkg/mac/build.sh $(BUILD_OPTS)
install-node:
cd web && yarn install
cd web && yarn install --immutable
install-python:
./tools/setup-python-env.sh
+32
View File
@@ -82,6 +82,38 @@ Select your preferred LLM provider from the dropdown:
After configuring your provider, click *Save* to apply the changes.
.. _ai_data_handling:
Data Handling and Provider Selection
************************************
When a cloud LLM provider is configured, pgAdmin transmits information about
your database to that provider's API. Depending on the feature in use, this may
include schema definitions such as table, column, index and constraint names
and data types; server and database configuration settings read from
``pg_settings``; query text; and EXPLAIN plan output. The *AI Assistant* in the
Query Tool is also able to run queries against your database, within a read-only
transaction and limited to 1000 rows, so row data may be included where the
assistant determines it is needed to answer a question.
None of this is transmitted unless you invoke an AI feature, and none of it is
transmitted at all when no provider has been configured, which is the default;
when AI features have been disabled by the administrator through the
``LLM_ENABLED`` setting; or when a locally hosted provider such as Ollama or
Docker Model Runner is configured.
Each provider processes this data under its own terms of service, privacy policy
and legal jurisdiction, and operates its infrastructure in locations of its own
choosing. If you work in an environment subject to data residency requirements,
procurement policies, or sector-specific rules governing the handling of
database metadata, review both the provider's terms and your own organisation's
policies before enabling a cloud provider.
The providers listed in pgAdmin reflect the APIs that pgAdmin is able to
communicate with. Their inclusion is not a recommendation, and no provider is
enabled by default.
Security Reports
****************
+29
View File
@@ -100,6 +100,10 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
* Move the switch next to *Only schemas* to limit the back up to schema-level
database objects.
* Move the switch next to *Only statistics* to the *Yes* position to limit
the back up to optimizer statistics. **Note:** This option is visible only
for database server greater than or equal to 18.
* Move the switch next to *Blobs* to the *No* position to exclude large
objects in the backup.
@@ -143,6 +147,22 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
Table access methods. **Note:** This option is visible only for
database server greater than or equal to 15.
* Move the switch next to *Row security policies* to the *Yes* position to
exclude row security policies. **Note:** This option is visible only for
database server greater than or equal to 18.
* Move the switch next to *Data* to the *Yes* position to exclude data from
the backup. **Note:** This option is visible only for database server
greater than or equal to 18.
* Move the switch next to *Schema* to the *Yes* position to exclude schema
(the data definitions) from the backup. **Note:** This option is visible
only for database server greater than or equal to 18.
* Move the switch next to *Statistics* to the *Yes* position to exclude
optimizer statistics. **Note:** This option is visible only for database
server greater than or equal to 18.
.. image:: images/backup_queries.png
:alt: Queries option on backup dialog
:align: center
@@ -259,6 +279,15 @@ tab to provide other backup options.
position to include a statement that will use a SET SESSION AUTHORIZATION
command to determine object ownership (instead of an ALTER OWNER command).
* Move the switch next to *Dump statistics* to the *Yes* position to include
optimizer statistics in the backup. It cannot be combined with *Only
data*, *Only schemas* or *Do not save* *Statistics*. **Note:** This option
is visible only for database server greater than or equal to 18.
* Move the switch next to *Sequence data* to the *Yes* position to include
sequence data that would normally be excluded. **Note:** This option is
visible only for database server greater than or equal to 18.
* Use the *Exclude schema* field to not dump schemas whose name matches
pattern.
+29
View File
@@ -45,6 +45,10 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
* Move the switch next to *Only roles* to limit the back up to roles only.
* Move the switch next to *Only statistics* to the *Yes* position to limit
the back up to optimizer statistics. **Note:** This option is visible only
for database server greater than or equal to 18.
.. image:: images/backup_server_do_not_save.png
:alt: Do not save option on backup server dialog
:align: center
@@ -88,6 +92,22 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
Table access methods. **Note:** This option is visible only for
database server greater than or equal to 15.
* Move the switch next to *Row security policies* to the *Yes* position to
exclude row security policies. **Note:** This option is visible only for
database server greater than or equal to 18.
* Move the switch next to *Data* to the *Yes* position to exclude data from
the backup. **Note:** This option is visible only for database server
greater than or equal to 18.
* Move the switch next to *Schema* to the *Yes* position to exclude schema
(the data definitions) from the backup. **Note:** This option is visible
only for database server greater than or equal to 18.
* Move the switch next to *Statistics* to the *Yes* position to exclude
optimizer statistics. **Note:** This option is visible only for database
server greater than or equal to 18.
.. image:: images/backup_server_queries.png
:alt: Queries option on backup server dialog
:align: center
@@ -171,6 +191,15 @@ tab to provide other backup options.
position to include a statement that will use a SET SESSION AUTHORIZATION
command to determine object ownership (instead of an ALTER OWNER command).
* Move the switch next to *Dump statistics* to the *Yes* position to include
optimizer statistics in the backup. It cannot be combined with *Only
data*, *Only schemas* or *Do not save* *Statistics*. **Note:** This option
is visible only for database server greater than or equal to 18.
* Move the switch next to *Sequence data* to the *Yes* position to include
sequence data that would normally be excluded. **Note:** This option is
visible only for database server greater than or equal to 18.
* Use the *Exclude database* field to not dump databases whose name matches
pattern.
+7 -5
View File
@@ -1,8 +1,8 @@
.. _change_password_dialog:
*******************************
`Change Password Dialog`:index:
*******************************
**************************************
`Change Server Password Dialog`:index:
**************************************
It is a good policy to routinely change your password to protect data, even in
what you may consider a 'safe' environment. In the workplace, failure to apply
@@ -30,7 +30,9 @@ comprehensive list and they **will not guarantee security**.
:alt: Change database password dialog
:align: center
Use the *Change Password* dialog to change your password:
Use the *Change Server Password* dialog to change the password of the role that
pgAdmin uses to connect to the database server, rather than the password you use
to log in to pgAdmin itself:
* The name displayed in the *User* field is the role for which you are modifying
the password; it is the role that is associated with the server connection
@@ -39,7 +41,7 @@ Use the *Change Password* dialog to change your password:
* Enter the desired password for in the *New Password* field.
* Re-enter the new password in the *Confirm Password* field.
Click the *Save* button to change your password.
Click the *Change* button to change your password.
Click the *Close* button to exit without changing your password.
+13 -6
View File
@@ -1,8 +1,8 @@
.. _change_user_password:
************************************
`Change User Password Dialog`:index:
************************************
***************************************
`Change pgAdmin Password Dialog`:index:
***************************************
It is a good policy to routinely change your password to protect data, even in
what you may consider a 'safe' environment. In the workplace, failure to apply
@@ -30,11 +30,18 @@ comprehensive list and they **will not guarantee security**.
:alt: Change current user password dialog
:align: center
Use the *Change Password* dialog to change your password:
Use the *Change pgAdmin Password* dialog to change the password you use to log
in to pgAdmin itself, rather than the password of a database server connection:
* Enter your existing password in the *Current Password* field.
* Enter the desired password for in the *New Password* field.
* Re-enter the new password in the *Confirm Password* field.
Click the *Change Password* button to change your password; click *Close* to
exit the dialog.
Click the *Change* button to change your password; click *Close* to exit the
dialog.
Changing your password signs out all of your other active sessions, so anyone
using your account elsewhere must sign in again with the new password. The
session you change it in stays signed in. When an administrator resets your
password from the :ref:`User Management <user_management>` page, all of your
sessions are signed out.
+3 -2
View File
@@ -5,8 +5,8 @@
*************************************
A PostgreSQL server can be deployed on the Amazon, Azure, Google cloud
using this module. In future more cloud provider options will be
available.
or pgEdge Starfleet using this module. In future more cloud provider
options will be available.
To launch the *Cloud Deployment...* tool, right click on the *Server Group* or
*Server* of the tree control, and select *Deploy a Cloud Instance* from the
@@ -18,3 +18,4 @@ To launch the *Cloud Deployment...* tool, right click on the *Server Group* or
cloud_aws_rds
cloud_azure_database
cloud_google_cloud_sql
cloud_pgedge_starfleet
+102
View File
@@ -0,0 +1,102 @@
.. _cloud_pgedge_starfleet:
************************************************
`pgEdge Starfleet Deployment`:index:
************************************************
To deploy a PostgreSQL database on pgEdge Starfleet, follow the steps below.
pgAdmin creates a *Managed* database, which Starfleet hosts for you.
.. image:: images/cloud_provider_for_postgresql.png
:alt: Cloud Deployment Provider
:align: center
Once you launch the tool, select the pgEdge Starfleet option and click on the
*Next* button to proceed.
.. image:: images/cloud_starfleet_credentials.png
:alt: pgEdge Starfleet credentials
:align: center
In the Credentials step, enter the *Auth ID* and *Auth secret* of a Starfleet
API client. pgAdmin checks them with Starfleet when you click *Next*.
.. note:: Create the API client in the pgEdge Starfleet console, under
*Settings > API Clients*. The Auth secret is shown only when the client is
created, so keep a copy of it. See the
`pgEdge Starfleet documentation <https://docs.pgedge.com/pgedge-starfleet/>`_
for details.
.. image:: images/cloud_starfleet_instance.png
:alt: pgEdge Starfleet instance specification
:align: center
Use the fields from the Instance Specification step to specify the database
details.
* Use the *Database name* field to name the database. The name may contain
lowercase letters and digits only, must start with a letter, and can be up
to 50 characters long.
* Use the *Display name* field to optionally set a friendlier name, up to 25
characters long.
* Select the location to deploy the database to from the *Region* field.
* Use the *Size* field to select the size of the database.
* Use the *PostgreSQL version* field to select the PostgreSQL version.
* Use the *Allowed IP addresses* field to list the IPv4 addresses or CIDR
ranges that may connect to the database, separated by commas. The field is
prefilled with your public IP address. At least one and at most 50 entries
are required; IPv6 addresses are not accepted. Without a matching entry the
database will not accept connections from pgAdmin.
* Use the *Connect as* field to choose whether pgAdmin connects as *admin*
(the database administrator, which is not a superuser) or *app* (an
application user).
.. image:: images/cloud_starfleet_database.png
:alt: pgEdge Starfleet database details
:align: center
In the Database Details step, use the *pgAdmin server group* field to select
the server group the new server will be registered in.
.. image:: images/cloud_starfleet_review.png
:alt: pgEdge Starfleet review
:align: center
Finally, review the summary in the Review step and click *Finish* to start the
deployment. The progress of the deployment is shown in the same way as for the
other cloud providers, and the new server is added to the *Object Explorer*
when the database is available. pgAdmin connects with *sslmode* set to
*require* and *gssencmode* set to *disable*.
If the deployment fails after the database has been created, for example
because pgEdge Starfleet reports it as failed or it does not become available
within 30 minutes, pgAdmin removes the server from the *Object Explorer* but
does not delete the database. Check the pgEdge Starfleet console, and delete
the database there if it is not needed.
.. image:: images/cloud_starfleet_password.png
:alt: pgEdge Starfleet database password
:align: center
pgEdge Starfleet generates the database password. When the deployment
finishes, pgAdmin shows it once in the *pgEdge Starfleet database password*
dialog, together with the host and user name.
* Use the *Copy* button to copy the password to the clipboard.
* Use the *Save password* button to save the password with the server. This
button is only shown if saving passwords is permitted by the
:ref:`ALLOW_SAVE_PASSWORD <config_py>` setting.
The password is not shown again in pgAdmin after the dialog is closed. If you
lose it, reset it from the pgEdge Starfleet console.
.. note:: pgAdmin contacts the Starfleet API at the address given by the
*STARFLEET_API_URL* configuration setting, which defaults to
*https://api.pgedge.com*. The address must use HTTPS.
+9 -3
View File
@@ -1,8 +1,8 @@
.. _config_py:
***************************
`The config.py File`:index:
***************************
*****************************
`Configuration Files`:index:
*****************************
There are multiple configuration files that are read at startup by pgAdmin. These
files are used for configuration options that:
@@ -32,6 +32,12 @@ The configuration files are as follows:
and may be created by users in the same directory as ``config.py`` if
needed.
.. note:: On macOS, ``config.py`` is located inside the application bundle
(``pgAdmin 4.app/Contents/Resources/web/``), which is replaced in its
entirety when pgAdmin is upgraded, so a ``config_local.py`` file created
there will be lost. Use ``config_system.py`` instead, which is stored
outside the application bundle.
* ``config_system.py``: This file is read after ``config_local.py`` and is
intended for system administrators to include settings that are configured
system-wide from a secure location that users cannot normally modify and that
+133 -16
View File
@@ -157,8 +157,10 @@ of the `Preferences JSON file <https://www.pgadmin.org/docs/pgadmin4/latest/pref
Override the default file path for the pgadmin configurations file.This can be used while provisioning
container with read only root file system to achieve a more secure pgadmin4 deployment for kubernetes.
Note that if you are externally mapping this file, then environment variables passed using *PGADMIN_CONFIG_*
suffix will be ignored.
Note that if you are externally mapping this file, then environment variables
passed using *PGADMIN_CONFIG_* suffix will be ignored only when that file
exists and is non-empty. A missing or empty file is generated with those
values.
**PGPASS_FILE**
@@ -167,6 +169,24 @@ Set this variable to the path of a pgpass file if you want to supply passwords
for the servers added in pgAdmin. On startup, the file is copied into the
container and used as the ``.pgpass`` file.
**PUID**
*Default: 5050*
The user ID that pgAdmin runs as. This is only used when the container is
started as root (for example with ``--user root``), in which case the
*pgadmin* user is given this UID, the ownership of */var/lib/pgadmin* is
changed to match, and pgAdmin is then run as that user rather than as root.
It is ignored when the container is started as any other user, which is the
default. The value must be numeric, and may not be 0.
**PGID**
*Default: 0*
The group ID that pgAdmin runs as. As with *PUID*, this is only used when the
container is started as root.
**GUNICORN_ACCESS_LOGFILE**
*Default: -* (stdout)
@@ -195,20 +215,62 @@ where it may be increased.
This is a variable prefix that can be used to override any of the configuration
options in pgAdmin's *config.py* file. Add the *PGADMIN_CONFIG_* prefix to any
variable name from *config.py* and give the value in the format 'string value'
for strings, True/False for booleans or 123 for numbers. See below for an
example.
variable name from *config.py* and give the value as a Python expression:
``'string value'`` (including the quotes) for strings, ``True`` or ``False``
for booleans, or ``123`` for numbers. See below for an example.
Settings are written to */pgadmin4/config_distro.py* within the container, which
is read after */pgadmin4/config.py* and before */pgadmin4/config_local.py*.
Any settings given will therefore override anything in config.py, but can be
overridden by settings in config_local.py.
*PGADMIN_DEFAULT_* variables, including *PGADMIN_DEFAULT_EMAIL* and
*PGADMIN_DEFAULT_PASSWORD*, are ordinary text and take no Python literal
quotes. *PGADMIN_CONFIG_* values are written as Python code into
*/pgadmin4/config_distro.py*, or into the file named by
*PGADMIN_CUSTOM_CONFIG_DISTRO_FILE* if that is set. The values ``true`` and
``false``, in any letter case, are written as ``True`` and ``False``. A bare
hostname is a Python name, so ``MAIL_SERVER = mail.example.com`` raises
``NameError`` at startup.
Settings are only written to */pgadmin4/config_distro.py* once, typically on
first launch of the container. If */pgadmin4/config_distro.py* contains one or
more lines, then no changes are made; for example, if the container instance is
restarted, or */pgadmin4/config_distro.py* is mapped to a file on persistent
storage (not recommended - use */pgadmin4/config_local.py* instead)!
Quoting added by the shell or by YAML sits outside that Python expression and
is removed before the value is written. The *docker run* example below keeps
the Python quotes inside shell quotes, for example
``-e 'PGADMIN_CONFIG_LOGIN_BANNER="Authorised users only!"'``.
In Docker Compose map syntax, YAML consumes the quotes around a scalar. A
YAML-only quoted hostname, ``PGADMIN_CONFIG_MAIL_SERVER: "mail.example.com"``
or ``PGADMIN_CONFIG_MAIL_SERVER: 'mail.example.com'``, reaches the container
as ``mail.example.com`` and cannot serve as a Python string. Nest the Python
quotes inside the scalar:
``PGADMIN_CONFIG_MAIL_SERVER: "'mail.example.com'"``. The container then
writes ``MAIL_SERVER = 'mail.example.com'``. ``"587"`` and ``"True"`` are
already valid Python, so they need no nested quotes. The list form keeps
single quotes, as ``docker run -e`` does
(``- PGADMIN_CONFIG_MAIL_SERVER='mail.example.com'``); nesting them there
produces ``"'mail.example.com'"``, which is valid Python but puts stray
quote characters into the value and fails silently rather than at startup.
An ``env_file`` value strips one layer of quotes, so the same nesting as the
map form applies there. The Compose example in the Examples section uses the
map form for an SMTP server, username, password, and *SECURITY_EMAIL_SENDER*.
Compose substitutes ``$VAR`` and ``${VAR}`` in Compose file values, and in
double-quoted ``env_file`` values, so write a literal dollar as ``$$``.
``"'pa$word'"`` reaches the container as ``'pa'``, with only a warning about
an unset variable. The entrypoint does not expand the value again, so ``$$``
is the only escaping required.
Settings are written to */pgadmin4/config_distro.py* within the container (or
to the file named by *PGADMIN_CUSTOM_CONFIG_DISTRO_FILE*), which is read after
*/pgadmin4/config.py* and before */pgadmin4/config_local.py*. Any settings
given will therefore override anything in config.py, but can be overridden by
settings in config_local.py.
The file is generated only when it is missing or empty, typically on first
launch, and a non-empty file is left unchanged, including when the container
is restarted. To apply corrected *PGADMIN_CONFIG_* values, recreate the
container (``docker compose up -d`` does this when the environment changes,
whereas ``docker compose restart`` does not), keeping the */var/lib/pgadmin*
mapping to retain your data. If the file is on persistent storage, either
because it is mapped (not recommended; use */pgadmin4/config_local.py*
instead) or because *PGADMIN_CUSTOM_CONFIG_DISTRO_FILE* points there,
recreating the container is not enough: edit the file, or empty it so that it
is regenerated.
See :ref:`config_py` for more information on the available configuration settings.
@@ -220,13 +282,37 @@ host machine to allow configuration to be customised and shared between
instances.
.. warning:: Warning: pgAdmin runs as the *pgadmin* user (UID: 5050) in the
*pgadmin* group (GID: 5050) in the container. You must ensure that all files
*root* group (GID: 0) in the container. You must ensure that all files
are readable, and where necessary (e.g. the working/session directory)
writeable for this user on the host machine. For example:
.. code-block:: bash
sudo chown -R 5050:5050 <host_directory>
sudo chown -R 5050:0 <host_directory>
When using rootless Podman, user IDs in the container are mapped to a
range of subordinate IDs on the host, so changing the ownership of a host
directory to 5050 as shown above does not make it writeable by the
container. Instead, either add the *U* option to the volume, which has
Podman recursively change the ownership of the directory and everything
in it to match the container's user, for example:
.. code-block:: bash
-v /path/to/pgadmin-data:/var/lib/pgadmin:U
or start the container as root, which in a rootless container is your own
user on the host. The container will change the ownership of
*/var/lib/pgadmin* and then run pgAdmin as the *pgadmin* user; see *PUID*
and *PGID* above. For example:
.. code-block:: bash
--user root
Neither option changes SELinux labels, so on a host with SELinux enforcing,
the volume also needs the *z* (shared) or *Z* (private) option to relabel
it, for example ``-v /path/to/pgadmin-data:/var/lib/pgadmin:Z,U``.
On some filesystems that do not support extended attributes, it may not be
possible to run pgAdmin without specifying a value for *PGADMIN_LISTEN_PORT*
@@ -304,6 +390,37 @@ Run a simple container over port 80, setting some configuration options:
-e 'PGADMIN_CONFIG_CONSOLE_LOG_LEVEL=10' \
-d dpage/pgadmin4
Run pgAdmin with Docker Compose, publishing port 80 and sending mail through
an external SMTP server. *PGADMIN_DEFAULT_EMAIL* and
*PGADMIN_DEFAULT_PASSWORD* are ordinary strings. Each *PGADMIN_CONFIG_*
string below includes the Python quotes that YAML would otherwise remove.
*PGADMIN_DISABLE_POSTFIX* may be any non-empty value; it is ordinary text,
not a Python expression. The named volume keeps */var/lib/pgadmin* when the
container is recreated:
.. code-block:: yaml
services:
pgadmin:
image: dpage/pgadmin4
ports:
- "80:80"
environment:
PGADMIN_DEFAULT_EMAIL: user@domain.com
PGADMIN_DEFAULT_PASSWORD: SuperSecret
PGADMIN_DISABLE_POSTFIX: "1"
PGADMIN_CONFIG_MAIL_SERVER: "'mail.example.com'"
PGADMIN_CONFIG_MAIL_PORT: "587"
PGADMIN_CONFIG_MAIL_USE_TLS: "True"
PGADMIN_CONFIG_MAIL_USERNAME: "'smtp-user'"
PGADMIN_CONFIG_MAIL_PASSWORD: "'s3cret=value'"
PGADMIN_CONFIG_SECURITY_EMAIL_SENDER: "'pgadmin@example.com'"
volumes:
- pgadmin-data:/var/lib/pgadmin
volumes:
pgadmin-data:
Run a TLS secured container using a shared config/storage directory in
/private/var/lib/pgadmin on the host, and servers pre-loaded from
/tmp/servers.json on the host:
+14 -2
View File
@@ -15,8 +15,15 @@ to specify the number of rows you would like to display in the editor panel.
To modify the content of a table, each row in the table must be uniquely
identifiable. If the table definition does not include an OID or a primary key,
the displayed data is read only. Note that views cannot be edited; updatable
views (using rules) are not supported.
the displayed data is read only. Simple, automatically-updatable views (a
single base table, with no ``INSTEAD OF`` triggers or rewrite rules, whose
base table's primary key columns are all exposed in the view under their
original names) can also be edited; updating and deleting rows is supported,
but inserting new rows through a view is not, so the *Add row* and *Paste*
buttons are disabled when editing a view. Materialized views, views based
on more than one table, views exposing only part of a composite primary key,
and views relying on ``INSTEAD OF`` triggers or rules created with
``CREATE RULE`` remain read only.
The editor features a toolbar that allows quick access to frequently used
options, and a work environment divided into two panels:
@@ -101,6 +108,11 @@ properties of the geometries directly in map, just click the specific geometry:
viewer will render geometries with the same SRID in the map. If SRID=4326 the
OSM tile layer will be added into the map.
- *Custom tile provider:* A custom map tile provider ({z}/{x}/{y} URL template,
in EPSG:3857, EPSG:4326 or EPSG:3395) can be configured as a base layer via
*Preferences > Query Tool > Geometry Viewer*. When configured, it is
selected as the default base layer.
- *Data size:* For performance reasons, the viewer will render no more than
100000 geometries, totaling up to 20MB.
+2 -2
View File
@@ -39,6 +39,8 @@ Use the fields in the *Definition* tab to define the function:
* Use the drop-down listbox next to *Return type* to select the data type
returned by the function, if any. If *Custom return type?* is enabled this field
will change to an input text field.
* Move the *Returns a set?* switch to indicate if the function returns a set
that includes multiple rows. The default is *No*.
* Use the drop-down listbox next to *Language* to select the implementation
language. The default is *sql*.
* Use the drop-down listbox next to *Depends on extensions* to select the extension that this function
@@ -88,8 +90,6 @@ function:
* *IMMUTABLE* indicates that the function cannot modify the database and
always returns the same result when given the same argument values.
* Move the *Returns a Set?* switch to indicate if the function returns a set
that includes multiple rows. The default is *No*.
* Move the *Strict?* switch to indicate if the function always returns NULL
whenever any of its arguments are NULL. If *Yes*, the function is not executed
when there are NULL arguments; instead a NULL result is assumed
Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

+12 -1
View File
@@ -132,10 +132,21 @@ The JSON file format used when importing or exporting servers is quite
straightforward and simply contains a list of servers, with a number of
attributes. The following attributes are required to be present in every server
definition: Name, Group, Port, Username, SSLMode, MaintenanceDB and one of Host,
HostAddr or Service.
HostAddr or Service. A shared server may supply SharedUsername in place of
Username, in which case the shared username is also used as the username of the
imported server.
Password fields cannot be imported or exported.
In desktop mode, ``PasswordExecCommand`` is the shell command to run, as shown
in the example below. In server mode it must instead be the name of a command
defined in the ``SERVER_PASSEXEC_COMMANDS`` setting (see :ref:`config_py`), and
the same name is written when servers are exported. A server whose
``PasswordExecCommand`` is not the name of a configured command is still
imported, but without a password exec command, and a warning naming the server
is printed. ``PasswordExecExpiration`` is imported only together with a valid
command name.
The following example shows both a minimally defined and a fully defined server:
.. code-block:: python
+1
View File
@@ -26,6 +26,7 @@ of database objects.
developer_tools
processes
pgagent
pgtimetable_chains
contributions
release_notes
licence
+77 -1
View File
@@ -34,7 +34,7 @@ from *config.py* file and modify the values for the following parameters.
through kerberos. If that authentication fails, then it will return back
to the login page where you need to provide internal pgAdmin user
credentials for authentication."
"KERBEROS_AUTO_CREATE_USER", "Set the value to *True* if you want to
"KRB_AUTO_CREATE_USER", "Set the value to *True* if you want to
automatically create a pgAdmin user corresponding to a successfully
authenticated Kerberos user. Please note that password is not stored in the
pgAdmin database."
@@ -126,6 +126,82 @@ PostgreSQL Server settings to configure Kerberos Authentication
* Note that, you have to login into pgAdmin with Kerberos authentication to
then connect to PostgreSQL using Kerberos.
* In server mode, the only Kerberos credentials used to connect to a
PostgreSQL server are those delegated by a user who logged in to pgAdmin
with Kerberos, and only for a server with "Kerberos authentication"
enabled. The default credential cache and client keytab of the operating
system account that pgAdmin runs as are never used, so a user cannot
connect to a server with that account's Kerberos identity.
* To enforce this for Windows SSPI, which uses the logon of the account
pgAdmin runs as, and for gssproxy, which environment variables do not
stop, in server mode pgAdmin also tells libpq what to use and what to
refuse.
* For a Kerberos-login user's connection to a server with Kerberos
authentication enabled, pgAdmin forces ``gsslib=gssapi``, replacing any
``gsslib`` the user set. Without it, a libpq built with both GSSAPI and
SSPI answers the server's request with SSPI, which uses the Windows
logon of the account pgAdmin runs as and ignores the delegated
credentials, whereas ``gsslib=gssapi`` makes libpq use the delegated
credential cache. This helps only with a Windows libpq build that
includes both GSSAPI and SSPI, as pgAdmin's Windows packages do. With
libpq 16 or later, SSPI is also refused with ``require_auth=!sspi``;
with an older libpq it is not refused.
* Every other connection uses ``require_auth=!gss,!sspi`` and
``gssencmode=disable``, merged with the server's own "Require
authentication" (``require_auth``) parameter. A server whose
``require_auth`` allows only ``gss`` can be used only by a
Kerberos-login user connecting to a server with Kerberos authentication
enabled, and one that allows only ``sspi`` cannot be used in server
mode.
* The ``require_auth`` protection needs libpq 16 or later in pgAdmin.
Without it only the ``KRB5CCNAME`` and ``KRB5_CLIENT_KTNAME`` isolation
applies to connections that may not use Kerberos, which does not cover
Windows SSPI or gssproxy. ``gssencmode`` needs libpq 12 or later;
``gsslib`` is known to every libpq that pgAdmin supports.
* psql and the utilities (such as pg_dump) get no ``require_auth`` in their
connection string unless the user set one for the server, which is then
merged as above. Their protection is the ``PGREQUIREAUTH``,
``PGGSSENCMODE`` and ``PGGSSLIB`` environment variables. Only a libpq
16 or later in the utility honours ``PGREQUIREAUTH``; an older one
ignores it silently.
* A service file entry's settings take precedence over these environment
variables for psql and the utilities, whereas pgAdmin's own connections
are not affected, because their connection string takes precedence over
the service file. Only a service listed in
``SERVER_MODE_ALLOWED_SERVICES`` can be used in server mode, so only an
entry the administrator has written can do this. Do not set
``require_auth``, ``gssencmode`` or ``gsslib`` in such an entry unless
every pgAdmin user may use what it allows: the ``KRB5CCNAME`` and
``KRB5_CLIENT_KTNAME`` isolation cannot be overridden by a service file,
but ``require_auth`` and ``gsslib`` in a listed service can re-enable
Windows SSPI or gssproxy for the utilities.
Accounts
========
A Kerberos user is only ever logged in to the Kerberos account whose username
is their principal (for example *user@EXAMPLE.COM*), never to an ``INTERNAL``
or other account with the same username. If there is no such Kerberos account
and *KRB_AUTO_CREATE_USER* is *False*, the login fails.
The administrator account created when pgAdmin is first set up is an
``INTERNAL`` account. If you use Kerberos authentication only, create a
Kerberos administrator account and deactivate the initial one:
.. code-block:: bash
/path/to/python /path/to/setup.py add-external-user user@EXAMPLE.COM --auth-source kerberos --admin
/path/to/python /path/to/setup.py update-user admin@example.com --inactive
See :ref:`Accounts from different authentication sources
<auth_source_accounts>` for more information.
Master Password
===============
+43 -39
View File
@@ -15,45 +15,47 @@ When using main browser window, the following keyboard shortcuts are available:
:class: longtable
:widths: 2 2 3
+----------------------------+--------------------+------------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
+============================+====================+====================================+
| Shift + Ctrl + a | Shift + Ctrl + a | Add grid row |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + b | Shift + Option + b | Object explorer |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + n | Shift + Option + n | Create object |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + d | Shift + Option + d | Delete object |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + g | Shift + Option + g | Direct debugging |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + e | Shift + Option + e | Edit object properties |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + f | Shift + Option + f | File main menu |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + h | Shift + Option + h | Help main menu |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + o | Shift + Option + o | Object main menu |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + q | Shift + Option + q | Open query tool |
+----------------------------+--------------------+------------------------------------+
| Shift + Ctrl + f | Shift + Ctrl + f | Quick Search |
+----------------------------+--------------------+------------------------------------+
| F5 | F5 | Refresh object explorer |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + s | Shift + Option + s | Search objects |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + [ | Shift + Option + [ | Tabbed panel backward |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + ] | Shift + Option + ] | Tabbed panel forward |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + w | Shift + Ctrl + w | Close tab panel |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + l | Shift + Option + l | Tools main menu |
+----------------------------+--------------------+------------------------------------+
| Shift + Alt + v | Shift + Option + v | View data |
+----------------------------+--------------------+------------------------------------+
+----------------------------+---------------------------+------------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
+============================+===========================+====================================+
| Shift + Ctrl + a | Shift + Ctrl + a | Add grid row |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + b | Shift + Option + b | Object explorer |
+----------------------------+---------------------------+------------------------------------+
| Ctrl + Alt + b | Ctrl + Option + b | Toggle Object Explorer |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + n | Shift + Option + n | Create object |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + d | Shift + Option + d | Delete object |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + g | Shift + Option + g | Direct debugging |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + e | Shift + Option + e | Edit object properties |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + f | Shift + Option + f | File main menu |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + h | Shift + Option + h | Help main menu |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + o | Shift + Option + o | Object main menu |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + q | Shift + Option + q | Open query tool |
+----------------------------+---------------------------+------------------------------------+
| Shift + Ctrl + f | Shift + Ctrl + f | Quick Search |
+----------------------------+---------------------------+------------------------------------+
| F5 | F5 | Refresh object explorer |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + s | Shift + Option + s | Search objects |
+----------------------------+---------------------------+------------------------------------+
| Ctrl + Alt + Page Up | Ctrl + Option + Page Up | Tabbed panel backward |
+----------------------------+---------------------------+------------------------------------+
| Ctrl + Alt + Page Down | Ctrl + Option + Page Down | Tabbed panel forward |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + w | Shift + Ctrl + w | Close tab panel |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + l | Shift + Option + l | Tools main menu |
+----------------------------+---------------------------+------------------------------------+
| Shift + Alt + v | Shift + Option + v | View data |
+----------------------------+---------------------------+------------------------------------+
Property Grid Controls
**********************
@@ -98,6 +100,8 @@ When using the syntax-highlighting SQL editors, the following shortcuts are avai
+--------------------------+----------------------+-------------------------------------+
| Ctrl + / | Cmd + / | Comment/Uncomment code (Block) |
+--------------------------+----------------------+-------------------------------------+
| Ctrl + Shift + d | Cmd + Shift + d | Duplicate current line/selection |
+--------------------------+----------------------+-------------------------------------+
| Ctrl + a | Cmd + a | Select all |
+--------------------------+----------------------+-------------------------------------+
| Ctrl + c | Cmd + c | Copy selected text to the clipboard |
+48 -2
View File
@@ -133,5 +133,51 @@ credentials is the responsibility of:
of pgAdmin and protects against attackers who would otherwise reach the
LDAP server through pgAdmin.
See :ref:`Avoiding a bruteforce attack <login>` for the equivalent note
on the login page.
See :ref:`Avoiding a bruteforce attack <avoiding_bruteforce>` for the equivalent note
on the login page.
Internal accounts
*****************
pgAdmin treats accounts from different authentication sources as separate
accounts, even when they share a username. An LDAP user is only ever logged
in to the LDAP account with that username, and never to an ``INTERNAL``
account with the same name, so each account keeps its own role and
settings.
The administrator account created when pgAdmin is first set up always uses
the ``INTERNAL`` authentication source. It remains in the pgAdmin database
when *AUTHENTICATION_SOURCES* is set to *['ldap']*, although it can then no
longer be used to log in. If you use LDAP authentication only, create an
LDAP administrator account, for example:
.. code-block:: bash
/path/to/python /path/to/setup.py add-external-user ldapuser --auth-source ldap --admin
and then deactivate the initial ``INTERNAL`` administrator account so that
it cannot be used if internal authentication is enabled again later:
.. code-block:: bash
/path/to/python /path/to/setup.py update-user admin@example.com --inactive
When both *internal* and *ldap* are listed in *AUTHENTICATION_SOURCES*, a
username and password entered on the login page are tried against each source
in turn, in the order they are listed, and the first source that accepts the
password signs the user in; the sources listed after it are not tried. Every
source listed before it is still tried, so the password is a failed attempt at
each of those. If the same username exists as both an internal and an LDAP
account, a wrong password sent to the directory is a failed LDAP bind that
counts towards the directory's lockout, even when a source listed later (such
as the internal account) then accepts the sign-in. pgAdmin's own lockout
counter for the internal account increases only when the sign-in fails at every
source. Avoid giving an internal and an LDAP account the same username.
When *LDAP_DN_CASE_SENSITIVE* is off, names that differ only in case are the
same login. Do not create two accounts whose usernames differ only in case;
pgAdmin cannot tell which one a sign-in is for.
See :ref:`Accounts from different authentication sources
<auth_source_accounts>` and :ref:`User Management <user_management>` for more
information on the ``setup.py`` user management commands.
+11 -4
View File
@@ -52,10 +52,17 @@ to launch a password recovery utility.
If you have forgotten the email associated with your account, please contact
your administrator.
Please note that your LDAP password cannot be recovered using this page. If
you enter your LDAP username in the *Email Address/Username* field, and then
enter your email to recover your password, an error message will be displayed
asking you to contact the LDAP administrator to recover your LDAP password.
Password recovery works only for accounts using the ``INTERNAL``
authentication source, which are the only accounts whose password pgAdmin
holds. Recovery looks up the email address you enter and acts on the ``INTERNAL``
account that has it: if one exists, reset instructions are sent for that
account. The password of an account authenticated against an external source
(``LDAP``, ``OAUTH2``, ``KERBEROS`` or ``WEBSERVER``) cannot be recovered here,
because it is held by that source; if the email belongs only to such an
account, an error asks you to contact that source's administrator. See
:ref:`Accounts from different authentication sources <auth_source_accounts>`.
.. _avoiding_bruteforce:
Avoiding a bruteforce attack
****************************
+1
View File
@@ -39,6 +39,7 @@ node, and select *Create Cast...*
publication_dialog
schema_dialog
sequence_dialog
statistics_dialog
subscription_dialog
synonym_dialog
trigger_function_dialog
+1 -1
View File
@@ -72,7 +72,7 @@ following options (in alphabetical order):
| | |
| 2) *Deploy Cloud Instance*| Click to open the :ref:`Cloud Deployment <cloud_deployment>` dialog to deploy an cloud instance. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Change Password...* | Click to open the :ref:`Change Password... <change_password_dialog>` dialog to change your password. |
| *Change Server Password...* | Click to open the :ref:`Change Server Password... <change_password_dialog>` dialog to change the server password. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Clear Saved Password* | If you have saved the database server password, click to clear the saved password. |
| | Enable only when password is already saved. |
+3
View File
@@ -30,6 +30,9 @@ modify the values for the following parameters.
"MFA_SUPPORTED_METHODS", "Set the authentication methods to be supported e.g. email, authenticator"
"MFA_EMAIL_SUBJECT", "<APP_NAME> - Verification Code e.g. pgAdmin 4 -
Verification Code"
"MFA_EMAIL_CODE_MAX_ATTEMPTS", "The number of wrong entries allowed for one
emailed verification code, after which the code is discarded and a new one
must be sent. The default value is 5. Values below 1 are treated as 1."
"MFA_FORCE_REGISTRATION", "Force the user to configure the authentication
method on login (if no authentication is already configured)."
+112
View File
@@ -11,6 +11,25 @@ file (see the :ref:`config.py <config_py>` documentation) on the system where
pgAdmin is installed in Server mode. You can copy these settings from *config.py*
file and modify the values for the following parameters.
.. warning::
pgAdmin reads OAuth2 provider settings **only** from the ``OAUTH2_CONFIG``
list; each provider is a single dictionary entry within that list. Settings
such as ``OAUTH2_CLIENT_ID`` or ``OAUTH2_SSL_CERT_VERIFICATION`` defined at
the top level of the configuration are ignored.
This matters in container deployments. Although most options can be set with
an individual ``PGADMIN_CONFIG_<KEY>`` environment variable, OAuth2 is the
exception: individual variables such as ``PGADMIN_CONFIG_OAUTH2_CLIENT_ID``
or ``PGADMIN_CONFIG_OAUTH2_SSL_CERT_VERIFICATION`` will **not** configure a
provider. Instead, configure the whole provider list through a single
``PGADMIN_CONFIG_OAUTH2_CONFIG`` variable, for example::
PGADMIN_CONFIG_OAUTH2_CONFIG="[{'OAUTH2_NAME': 'my-provider', 'OAUTH2_DISPLAY_NAME': 'My Provider', 'OAUTH2_CLIENT_ID': '...', 'OAUTH2_CLIENT_SECRET': '...', 'OAUTH2_SERVER_METADATA_URL': 'https://provider.example.com/.well-known/openid-configuration', 'OAUTH2_SCOPE': 'openid email profile', 'OAUTH2_SSL_CERT_VERIFICATION': False}]"
If pgAdmin detects per-provider OAuth2 settings at the top level while no
provider is configured in ``OAUTH2_CONFIG``, it logs a warning at startup
to highlight the misconfiguration.
OAuth2 vs OpenID Connect (OIDC)
================================
@@ -69,11 +88,46 @@ and secure.
"OAUTH2_AUTO_CREATE_USER", "Set the value to *True* if you want to automatically
create a pgAdmin user corresponding to a successfully authenticated Oauth2 user.
Please note that password is not stored in the pgAdmin database."
"OAUTH2_AUTO_LOGIN", "Set the value to *True* to send users straight to the OAuth2 provider
instead of showing the pgAdmin login page. This only takes effect when *oauth2* is the only
value in AUTHENTICATION_SOURCES and exactly one provider is configured. The default is *False*.
See :ref:`oauth2_auto_login` below."
"OAUTH2_ADDITIONAL_CLAIMS", "If a dictionary is provided, pgAdmin will check for a matching key and value on the **ID token first** (for OIDC providers), then fall back to the userinfo endpoint response. In case there is no match with the provided config, the user will receive an authorization error. Useful for checking AzureAD_ *wids* or *groups*, GitLab_ *owner*, *maintainer* and *reporter* claims."
"OAUTH2_SERVER_GROUP_CLAIM", "The name of a claim listing the server groups whose shared servers the user may access. If set, shared servers owned by other users are only visible and accessible if the name of their server group is in the claim. See :ref:`oauth2_server_group_claims` below."
"OAUTH2_SERVER_GROUP_CLAIM_MAPPING", "An optional dictionary mapping values of the OAUTH2_SERVER_GROUP_CLAIM claim to a server group name or a list of server group names. Values without a mapping are used as server group names unchanged."
"OAUTH2_SSL_CERT_VERIFICATION", "Set this variable to False to disable SSL certificate verification for OAuth2 provider.
This may need to set False, in case of self-signed certificates."
"OAUTH2_CHALLENGE_METHOD", "Enable PKCE workflow. PKCE method name, only *S256* is supported"
"OAUTH2_RESPONSE_TYPE", "Enable PKCE workflow. Mandatory with OAUTH2_CHALLENGE_METHOD, must be set to *code*"
"OAUTH2_LOGOUT_URL", "The provider's logout endpoint, used to end the user's session with the provider
when they log out of pgAdmin. *{redirect_uri}* and *{id_token}* in the value are replaced with the pgAdmin
URL and the user's ID token. Ex: *https://example.com/realms/master/protocol/openid-connect/logout?post_logout_redirect_uri={redirect_uri}&id_token_hint={id_token}* (for Keycloak)"
Accounts
========
An OAuth2 user is only ever logged in to the OAuth2 account whose username is
the one resolved from their identity. When *OAUTH2_USERNAME_CLAIM* is set, that
claim is used, taken from the ID token if present and otherwise from the
userinfo profile. When it is not set, an OIDC provider uses the first of
``email``, ``preferred_username`` or ``sub`` that is present, and a non-OIDC
provider uses the email address. The user is never logged in to an ``INTERNAL``
or other account with the same username. If there is no such OAuth2 account and
*OAUTH2_AUTO_CREATE_USER* is *False*, the login fails. When you provision an
administrator account for an OAuth2-only deployment, give it the username your
provider resolves to, which may not be the email address.
The administrator account created when pgAdmin is first set up is an
``INTERNAL`` account. If you use OAuth2 authentication only, create an OAuth2
administrator account and deactivate the initial one:
.. code-block:: bash
/path/to/python /path/to/setup.py add-external-user user@example.com --auth-source oauth2 --admin
/path/to/python /path/to/setup.py update-user admin@example.com --inactive
See :ref:`Accounts from different authentication sources
<auth_source_accounts>` for more information.
Redirect URL
============
@@ -100,6 +154,21 @@ After configuration, on restart, you can see the login page with the Oauth2 logi
:alt: Oauth2 login
:align: center
.. _oauth2_auto_login:
Skipping the Login Page
-----------------------
If OAuth2 is the only authentication source and a single provider is configured, set
OAUTH2_AUTO_LOGIN to *True* to send users straight to the provider rather than showing them the
login page with a single button. Note that any LOGIN_BANNER will not be seen in this case.
The login page is still shown after a login fails, so that the error can be read, and after the
user logs out, so that they are not logged straight back in by the provider. Setting
OAUTH2_LOGOUT_URL for the provider is recommended, so that logging out of pgAdmin also ends the
user's session with the provider. To show the login page at any other time, add *?no_auto_login*
to its URL, for example *https://pgadmin.example.com/login?no_auto_login*.
PKCE Workflow
=============
@@ -323,6 +392,49 @@ Example:
# then userinfo endpoint if not found
}]
.. _oauth2_server_group_claims:
Restricting Shared Servers with a Claim
---------------------------------------
**OAUTH2_SERVER_GROUP_CLAIM** limits which shared servers an OAuth2 user can
see, based on a claim from the identity provider such as a list of roles or
groups. When it is set:
* A shared server owned by another user is only visible, and can only be
connected to, if the name of the server group it is in appears in the claim.
* If the claim is missing for a user, they see no shared servers owned by
other users.
* Servers and server groups that the user owns themselves are not affected.
* Users who log in by other methods are not affected.
The claim is read from the ID token first, then from the userinfo endpoint
response. Its value may be a string or a list of strings; values of any other
type (for example, group objects returned by some providers) are ignored.
Server group names are matched exactly, with no trimming or case folding.
**OAUTH2_SERVER_GROUP_CLAIM_MAPPING** can be used to translate claim values
into server group names. A value may map to a single name or a list of names,
and values with no mapping are used as server group names unchanged.
The claim is only read when the user logs in, so changes made at the identity
provider take effect at the user's next login.
Example:
.. code-block:: python
OAUTH2_CONFIG = [{
# ... other config ...
'OAUTH2_SERVER_GROUP_CLAIM': 'roles',
'OAUTH2_SERVER_GROUP_CLAIM_MAPPING': {
'dba': ['Production', 'Staging'],
'developer': 'Staging'
},
# A user with the roles ['developer', 'Reporting'] can see shared
# servers in the 'Staging' and 'Reporting' server groups.
}]
Legacy OAuth2 Configuration (Without OIDC)
-------------------------------------------
+239
View File
@@ -0,0 +1,239 @@
.. _pgtimetable_chains:
***************************************
`pgTimeTable Chains`:index:
***************************************
**pg_timetable** is a PostgreSQL-based scheduling agent that runs and manages what are called `Chains`.
Each chain is composed of a set of Tasks to be executed in the order they should run.
A chain is assigned a single schedule using an extended cron-style format.
This UI has been tested with pg_timetable 6.3.0 and above.
A task may be a series of *SQL* statements, a *BUILTIN* pg_timetable command (such as sending email)
or an operating system *PROGRAM* program/batch/shell script.
Switches on the *pgTimeTable Chain* dialog (accessed
through the *Properties* context menu) allow you to modify a chain or disable the whole chain,
as well as modify tasks within the chain.
When you highlight the name of a defined chain in the pgAdmin tree control, the
*Properties* tab of the main pgAdmin window will display details about the chain,
and the *Statistics* tab will display details about the chain's execution.
There are also statistics about each task.
pg_timetable supports the ability to have more than one job agent running at a time.
Job agents can be deployed on various platforms and binaries are readily available to
deploy on Linux, Windows, and Mac.
For complete installation instructions, configuration options, and command-line
usage, please refer to the
`pg_timetable documentation <https://cybertec-postgresql.github.io/pg_timetable/>`_.
If you are migrating from pgAgent or another PostgreSQL based scheduler, pg_timetable provides
migration SQL queries to help in that migration. See the
`migration tools <https://github.com/cybertec-postgresql/pg_timetable/tree/master/extras>`_
on GitHub for details.
Viewing pgTimeTable
********************
To enable viewing of the *pgTimeTable Chains* node, enable it on the File -> Preferences -> Nodes.
It will only show if the schema *timetable* and associated tables exist in your maintenance database.
Creating a Chain
****************
Note that pg_timetable is not installed via `CREATE EXTENSION`.
Instead you use a pgTimeTable agent to install the necessary tables.
To create or manage a chain, use the pgAdmin tree control to browse to the
server on which the timetable schema exists. The tree control will
display a *pgTimeTable Chains* node, under which currently defined chains are
displayed.
To add a new chain, right click on the *pgTimeTable Chains* node,
and select *Create pgTimeTable Chain...* from the context menu.
When the chain dialog opens, use the tabs on the dialog to define the chain
and its tasks.
.. image:: images/pgtimetable_chain_general.png
:alt: pgTimeTable chain dialog general tab
:align: center
Use the fields on the *General* tab to provide general information about the
chain:
* Provide a name for the chain in the *Name* field.
* Move the *Enabled* switch to the *Yes* position to enable the chain, or
*No* to disable it.
* Use the *Max instances* field to specify the number of parallel instances
(clients) that may execute this chain simultaneously. Leave the field blank
to allow unlimited parallel execution.
* Use the *Timeout (ms)* field to specify the maximum number of milliseconds
the chain may run before it is aborted. A value of *0* means no timeout.
* Move the *Self-destruct* switch to *Yes* to have the chain delete itself
after a successful run.
* Move the *Exclusive execution* switch to *Yes* to pause all other parallel
chains while this chain is executing.
* Use the *Host agent* field to specify the client name of the agent running
pgTimeTable that should execute this chain. Leave the field blank to allow
any available host to run the chain.
.. note:: You can query the ``timetable.active_session`` view to see the
client names reported by running pgTimeTable agents:
.. code-block:: sql
SELECT DISTINCT client_name FROM timetable.active_session
Use the client name exactly as reported by the query in the *Host agent*
field.
* Use the *On error* field to specify the behavior when an error occurs.
Accepted values are:
* *NULL* - Use the default error handling.
* *LOG* - Log the error and continue execution.
* *ABORT* - Abort the chain on error.
* Use the *Schedule* field to specify a cron-style schedule for the chain.
The format consists of a single field with 5 slots. As with regular cron,
you can use a comma (`,`) for multiple values and an asterisk (`*`) as a wildcard for all.
E.g. `20 1,5 * * *` would run at 1:20 and 5:20 AM.
The timezone is always the timezone of the server the pgTimeTable database resides on.
.. code-block:: text
* * * * *
| | | | |
| | | | +---- day of the week (0 - 7) (0 and 7 = Sunday)
| | | +------ month (1 - 12)
| | +-------- day of the month (1 - 31)
| +---------- hour (0 - 23)
+------------ minute (0 - 59)
If you leave the field blank it runs every minute
(the effective schedule is `* * * * *`).
In addition to cron syntax, pgTimeTable supports additional special case formats.
Namely `@after`, `@every`, `@reboot`.
The `@every` and `@after` should be followed with additional arguments.
For example `@every 2 hours`.
.. image:: images/pgtimetable_chain_tasks.png
:alt: pgTimeTable chain dialog tasks tab
:align: center
Use the *Tasks* tab to define and manage the tasks that the chain will
execute. Click the Add icon (+) to add a new task. Tasks are executed in
order of their *Order* value.
Click the compose icon (located at the left side of the header) to open the
task definition dialog. See `Chain Task Dialog`_ below for details on
defining a task.
When you have finished defining the chain, you can use the *SQL* tab to review
the SQL that will create or modify your chain.
Click the *Save* button to save the chain, or *Close* to exit without saving.
Use the *Reset* button to remove your unsaved entries from the dialog.
After saving a chain, the chain will be listed under the *pgTimeTable Chains*
node of the pgAdmin tree control. The *Properties* tab in the main pgAdmin
window will display a high-level overview of the selected chain, and the
*Statistics* tab will show the details of each execution run.
.. image:: images/pgtimetable_chain_properties.png
:alt: pgTimeTable chain properties
:align: center
To modify an existing chain or to review detailed information about a chain,
right-click on a chain name, and select *Properties* from the context menu.
Chain Task Dialog
*****************
A chain task defines a single unit of work to be performed as part of a chain.
Each chain can contain one or more tasks, which are executed sequentially in
order.
.. image:: images/pgtimetable_task_general.png
:alt: pgTimeTable task dialog general tab
:align: center
Use the fields on the *General* tab to define the task:
* Provide a name for the task in the *Name* field.
* Use the *Order* field to specify the execution order of the task within the
chain. Tasks are executed in ascending order by this value.
* Use the *Kind* drop-down to select the type of task:
* *SQL* - The task executes SQL statements.
* *PROGRAM* - The task executes an operating system command.
* *BUILTIN* - The task executes one of the built-in pgTimeTable commands.
* When *Kind* is set to *SQL*, use the *Connection string* field to optionally
specify a libpq-style connection string for a remote database. Leave the
field blank to execute against the pgTimeTable database.
.. note:: The *Connection string* field is only available when the
pgTimeTable extension version supports it (version 5.x or later).
It is ignored for *PROGRAM* and *BUILTIN* task kinds.
* Move the *Ignore error* switch to *Yes* to continue chain execution even if
this task fails. Set to *No* to stop the chain when an error occurs.
.. image:: images/pgtimetable_task_code.png
:alt: pgTimeTable task dialog code tab
:align: center
Use the *Code* tab to provide the code or command for the task. The content
of the *Code* tab depends on the selected *Kind*:
* If *Kind* is *SQL*, provide one or more SQL statements in the *SQL* field.
Use ``$1``, ``$2``, etc. as parameter placeholders that will be substituted
from the *Parameters* collection.
* If *Kind* is *PROGRAM*, provide the full path and arguments of the program
to execute in the *Program* field.
* If *Kind* is *BUILTIN*, select one of the following internal commands from
the *Internal Command* drop-down:
* *NoOp* - No operation; the task completes immediately.
* *Sleep* - Pause execution for a duration specified by a parameter.
* *Log* - Write a message to the pgTimeTable log.
* *SendMail* - Send an email (requires parameters for recipient, subject,
and body).
* *Download* - Download a file from a URL.
* *CopyFromFile* - Copy data from a file into a database table.
* *CopyToFile* - Copy data from a database table to a file.
* *Shutdown* - Shut down the pgTimeTable service.
.. image:: images/pgtimetable_task_parameters.png
:alt: pgTimeTable task dialog parameters
:align: center
Use the *Parameters* sub-collection to define parameter values that will be
substituted into the task command. Click the Add icon (+) to add a new
parameter row:
* Use the *Order* column to specify the parameter position (``$1``, ``$2``,
etc.).
* Use the *Value* column to provide the parameter value. The value may be a
plain string or a JSON value.
Click the compose icon to close the task definition dialog, then click *Save*
on the chain dialog to save all changes.
Refer to `pg_timetable samples <https://cybertec-postgresql.github.io/pg_timetable/latest/samples/>`_
for the kind of parameters expected for each type.
Both the Chain and Tasks have a statistics tab, which show the results of past runs of tasks.
.. image:: images/pgtimetable_task_statistics.png
:alt: pgTimeTable task statistics
:align: center
+45
View File
@@ -589,6 +589,15 @@ Use the fields on the *CSV/TXT Output* panel to control the CSV/TXT output.
quoted in the CSV/TXT output; select *Strings*, *All*, or *None*.
* Use the *Replace null values with* option to replace null values with
specified string in the output file. Default is set to 'NULL'.
* Use the *Output file encoding* drop-down listbox to specify the character
encoding used when saving query results to a file. The default is utf-8; an
encoding that is not listed can also be typed in. Any character that the
chosen encoding cannot represent is written as a question mark (?).
* Use the *Add byte order mark (BOM)?* switch to add a byte order mark at the
start of the saved file when a UTF encoding is used. This helps applications
such as Microsoft Excel detect the encoding correctly. This applies to the
CSV/TXT output only. The utf-16, utf-32 and utf-8-sig encodings always
include a BOM, whatever this is set to.
.. image:: images/preferences_sql_display.png
:alt: Preferences sqleditor display options
@@ -635,6 +644,39 @@ a graphical EXPLAIN.
* When the *Verbose output?* switch is set to *True*, graphical explain details
will include extended information about the query execution plan.
Use the fields on the *Geometry Viewer* panel to configure a custom map tile
provider used as a base layer when viewing geometry data.
* Use the *Custom tile provider URL* field to specify the URL template of a
custom XYZ tile provider, e.g.
``https://myserver.example.com/tiles/{z}/{x}/{y}.png``. The template must
contain the ``{x}``, ``{y}`` and ``{z}`` placeholders, and may contain
``{s}`` for subdomains (a, b, c). Leave the field empty to disable the
custom tile provider.
* Use the *Custom tile provider name* field to specify the display name of
the custom tile provider in the layer selector of the Geometry Viewer.
* Use the *Custom tile provider CRS* field to specify the coordinate
reference system of the custom tile provider. If it is not EPSG:3857
(Web Mercator), the built-in tile layers will be hidden as they cannot be
mixed with other coordinate systems.
* Use the *Custom tile provider attribution* field to specify the
attribution text shown on the map. It may contain HTML links.
* Use the *Custom tile provider max zoom* field to specify the maximum zoom
level of the custom tile provider.
When a custom tile provider is configured, it is selected as the default
base layer of the Geometry Viewer.
An administrator may set a system-wide default for these fields via the
``DEFAULT_GEOMETRY_VIEWER_PROVIDER`` setting in :ref:`config_py`. It applies
to any user who has not saved their own values for the fields above; a
user's own preferences, once saved, always take precedence over the
system-wide default.
.. image:: images/preferences_graph_visualiser.png
:alt: Preferences sqleditor graph visualiser section
:align: center
@@ -721,6 +763,9 @@ preferences for copied data.
character for copied data.
* Use the *Result copy quoting* drop-down listbox to select which type of fields
require quoting; select *All*, *None*, or *Strings*.
* When the *Copy with headers?* switch is set to true, the column headers are
included by default when copying data from the results grid. This can still
be toggled per-copy from the results grid copy options menu.
* When the *Striped rows?* switch is set to true, the result grid will display
rows with alternating background colors.
+3 -1
View File
@@ -243,7 +243,9 @@ iteratively. For example, you can ask for a query and then follow up with
**Note:** The AI Assistant uses database schema inspection tools to understand
your database structure. It supports SELECT, INSERT, UPDATE, DELETE, and DDL
statements. All generated queries should be reviewed before execution.
statements. All generated queries should be reviewed before execution. See
:ref:`ai_data_handling` for details of the information that is transmitted to
your configured LLM provider.
The Data Output Panel
*********************
+6 -4
View File
@@ -210,10 +210,12 @@ Data Editing Options
| *Save Data Changes* | Click the *Save Data Changes* icon to save data changes (insert, update, or delete) in the Data | F6 |
| | Output Panel to the server. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Save results to* | Click the Save results to file icon to save the result set of the current query as a delimited | F8 |
| *file* | text file (CSV, if the field separator is set to a comma). This button will only be enabled when | |
| | a query has been executed and there are results in the data grid. You can specify the CSV/TXT | |
| | settings in the Preference Dialogue under SQL Editor -> CSV/TXT output. | |
| *Save results to* | Click the Save results to file icon to save the result set of the current query. By | F8 |
| *file* | default it is saved as a delimited text file (CSV, if the field separator is set to a | |
| | comma). Use the adjacent drop-down list to instead save the results as JSON or XML. | |
| | This button is only enabled when a query has been executed and there are results in | |
| | the data grid. You can specify the CSV/TXT settings (including the output file encoding | |
| | and byte order mark) in the Preferences dialog under Query Tool -> CSV/TXT Output. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Graph Visualiser | Use the Graph Visualiser button to generate graphs of the query results. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
+3
View File
@@ -12,6 +12,9 @@ notes for it.
:maxdepth: 1
release_notes_9_19
release_notes_9_18
release_notes_9_17
release_notes_9_16
release_notes_9_15
release_notes_9_14
+119
View File
@@ -0,0 +1,119 @@
************
Version 9.17
************
Release date: 2026-07-30
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.16.
Supported Database Servers
**************************
**PostgreSQL**: 14, 15, 16, 17 and 18
**EDB Advanced Server**: 14, 15, 16, 17 and 18
Bundled PostgreSQL Utilities
****************************
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.4
New features
************
| `Issue #9990 <https://github.com/pgadmin-org/pgadmin4/issues/9990>`_ - Include the authenticated user's identity in the HTTP access log.
| `Issue #9942 <https://github.com/pgadmin-org/pgadmin4/issues/9942>`_ - Add an opt-in Gateway API HTTPRoute template to the Helm chart as an alternative to the existing Ingress.
| `Issue #10104 <https://github.com/pgadmin-org/pgadmin4/issues/10104>`_ - Add a preference to cap the row count fetched by the plain "View Data" action, so it is usable on large tables without always doing a full ``SELECT *``.
| `Issue #10142 <https://github.com/pgadmin-org/pgadmin4/issues/10142>`_ - Add support for a custom XYZ tile provider (URL, name, CRS, attribution, max zoom) in the Geometry Viewer, alongside the existing built-in base layers.
Housekeeping
************
| `Issue #10077 <https://github.com/pgadmin-org/pgadmin4/issues/10077>`_ - Centralize shared-server-group visibility and access-control logic, and adjust the ServerGroup-to-Server/SharedServer model relationships.
| `Issue #10093 <https://github.com/pgadmin-org/pgadmin4/issues/10093>`_ - Add a basic starter contributing guide.
| `Issue #10135 <https://github.com/pgadmin-org/pgadmin4/issues/10135>`_ - Fail the macOS appbundle build if any bundled library links outside the bundle, and scan all Mach-O binaries for bundle linkage rather than only files named ``.so``/``.dylib``.
| `Issue #10154 <https://github.com/pgadmin-org/pgadmin4/issues/10154>`_ - Pin the sonarqube-scan-action GitHub workflow to a full commit SHA instead of a mutable branch ref, to harden against supply-chain tampering.
| `Issue #10138 <https://github.com/pgadmin-org/pgadmin4/issues/10138>`_ - Update the Simplified Chinese (zh_Hans_CN) translation to match the wording used in the interface.
| `Issue #10156 <https://github.com/pgadmin-org/pgadmin4/issues/10156>`_ - Pin the Yarn version used by the build scripts to the ``packageManager`` field, rather than whatever Yarn happens to be on the builder's PATH.
| `Issue #10176 <https://github.com/pgadmin-org/pgadmin4/issues/10176>`_ - Bump JavaScript and Python third-party dependencies, including axios, webpack, react, electron, and certifi.
Bug fixes
*********
| `Issue #10053 <https://github.com/pgadmin-org/pgadmin4/issues/10053>`_ - Warn when OAuth2 provider settings are misplaced at the top level of the config instead of under ``OAUTH2_CONFIG``.
| `Issue #10100 <https://github.com/pgadmin-org/pgadmin4/issues/10100>`_ - Fix Schema Diff's "Generate Script" and the browser tree's CREATE Script view emitting wrong SQL for SERIAL/identity columns, by detecting column-owned sequences via pg_depend instead of guessing the sequence name.
| `Issue #10102 <https://github.com/pgadmin-org/pgadmin4/issues/10102>`_ - Fix a Schema Diff result-status filter chip showing "No difference found" after being toggled off and back on, even when real differences exist.
| `Issue #10106 <https://github.com/pgadmin-org/pgadmin4/issues/10106>`_ - Fix the Object Explorer briefly showing the literal HTML markup instead of a greyed-out "[Disconnecting...]" label when disconnecting a server or database.
| `Issue #10107 <https://github.com/pgadmin-org/pgadmin4/issues/10107>`_ - Detect a selected-but-unusable OS keyring and fall back gracefully instead of failing.
| `Issue #10109 <https://github.com/pgadmin-org/pgadmin4/issues/10109>`_ - Fix ALT+F5 ("Execute query at cursor") doing nothing when the cursor is on or near a statement that is not highlighted, in a Query Tool tab with multiple statements separated by blank lines.
| `Issue #10110 <https://github.com/pgadmin-org/pgadmin4/issues/10110>`_ - Stop the googleapiclient cloud-deployment dependency from pulling in the system oauth2client package.
| `Issue #10117 <https://github.com/pgadmin-org/pgadmin4/issues/10117>`_ - Fix a "'Response' object is not iterable" crash when expanding a Trigger node under a Table to view its trigger function, and report the correct error message on a node.sql failure in that flow.
| `Issue #10158 <https://github.com/pgadmin-org/pgadmin4/issues/10158>`_ - Honor the selected EOL sequence when copying query text to the clipboard.
| `Issue #10187 <https://github.com/pgadmin-org/pgadmin4/issues/10187>`_ - Fix the object browser's extension UI breaking under PostgreSQL 19's extension catalog changes.
| `Issue #10190 <https://github.com/pgadmin-org/pgadmin4/issues/10190>`_ - Fix a tool-permission bypass where a user denied the Query Tool, Grant Wizard, or Schema Diff permission could still drive that tool's backend routes and Socket.IO handlers directly, since the permission check was applied only to a single "front door" route per tool. Also fixes a non-owner triggering an adhoc connection against another user's shared server persisting a new server record still owned by that other user (CVE-2026-17350). Reported by LXY.
| `Issue #10191 <https://github.com/pgadmin-org/pgadmin4/issues/10191>`_ - Fix OS command injection in the MASTER_PASSWORD_HOOK feature, where an externally-sourced username (e.g. via OAuth2/OIDC, Kerberos, or webserver authentication) containing shell metacharacters could execute arbitrary commands as the pgAdmin service account when the configured hook string uses ``%u`` (CVE-2026-17347). Reported by Thiago Pereira.
| `Issue #10192 <https://github.com/pgadmin-org/pgadmin4/issues/10192>`_ - Fix a lexer-differential bypass of the AI Assistant's read-only transaction guard, where sqlparse's string-literal lexing disagreed with PostgreSQL's own parser under ``standard_conforming_strings = on``, letting a crafted multi-statement payload smuggle a COMMIT past the intended read-only wrapper, an incomplete fix for CVE-2026-12045 (CVE-2026-17351). Reported by Kai Aizen.
| `Issue #10193 <https://github.com/pgadmin-org/pgadmin4/issues/10193>`_ - Fix SQL injection in the Index Statistics all-indexes listing and the Publications/Subscriptions Dependencies views, where an apostrophe in a table, index, publication, or subscription name broke out of an unescaped template interpolation, an incomplete fix for CVE-2026-12044 (CVE-2026-17346). Reported by Hung Tran Quoc (@rampage0010).
| `Issue #10194 <https://github.com/pgadmin-org/pgadmin4/issues/10194>`_ - Fix several Constraints, Preferences, Debugger, and Schema Diff routes missing the ``@pga_login_required`` decorator, making them reachable without authentication in server mode, an incomplete fix for CVE-2026-12046 (CVE-2026-17348). Reported by Hung Tran Quoc (@rampage0010).
| `Issue #10200 <https://github.com/pgadmin-org/pgadmin4/issues/10200>`_ - Fix an adhoc server connection cloning another user's stored database credentials (password, save password flag, tunnel password) alongside ownership, letting a non-owner who cloned another user's shared server connect using that user's saved database password (CVE-2026-17349).
| `Issue #10213 <https://github.com/pgadmin-org/pgadmin4/issues/10213>`_ - Fix OS command injection in the Import/Export Data tool, where a query-based export could pass a crafted query string past the ``\copy (...)`` parenthesis-balance guard by exploiting a backslash-escape mismatch with psql's default ``standard_conforming_strings = on`` behaviour, exposing a live ``TO PROGRAM`` clause for arbitrary command execution (CVE-2026-17566). Reported by Arpit Jain.
Additional changes (no associated issue)
****************************************
Dependencies
------------
Non-breaking ``dependabot`` and audit-driven bumps aggregated for v9.17.
Python:
| ``certifi`` 2026.5.20 -> 2026.6.17
JavaScript (``web/``):
| ``@babel/core`` 7.29.0 -> 7.29.6
| ``@date-io/date-fns`` 3.x -> 3.2.1
| ``@szhsin/react-menu`` 4.5.1 -> 4.5.2
| ``@tanstack/react-query`` 5.100.9 -> 5.101.4
| ``@types/react`` 19.2.14 -> 19.2.17
| ``ajv`` 8.18.0 -> 8.20.0
| ``anti-trojan-source`` 1.8.1 -> 1.12.0
| ``autoprefixer`` 10.5.0 -> 10.5.4
| ``axios`` 1.16.0 -> 1.18.1
| ``core-js`` added as an explicit direct dependency (3.49.0), previously relied on transitively via pickr
| ``date-fns`` 4.1.0 -> 4.4.0
| ``dompurify`` 3.4.1 -> 3.4.12
| ``eslint-plugin-jest`` 29.15.2 -> 29.15.5
| ``globals`` 17.5.0 -> 17.7.0
| ``hotkeys-js`` 4.0.3 -> 4.0.4
| ``html-to-image`` 1.11.11 -> 1.11.13
| ``ip-address`` 10.1.1 -> 10.2.0
| ``jest`` / ``jest-environment-jsdom`` 30.3.0 -> 30.4.2 / 30.4.1
| ``marked`` 18.0.2 -> 18.0.7
| ``moment-timezone`` 0.6.2 -> 0.6.3
| ``papaparse`` 5.5.3 -> 5.5.4
| ``postcss`` 8.5.10/8.5.14 -> 8.5.20
| ``react`` / ``react-dom`` 19.2.5 -> 19.2.7
| ``react-checkbox-tree`` 2.0.1 -> 2.0.2
| ``react-draggable`` 4.5.0 -> 4.7.0
| ``react-timer-hook`` 4.0.5 -> 4.0.6
| ``sharp`` 0.34.4 -> 0.35.3
| ``sql-formatter`` 15.7.3 -> 15.8.2
| ``svgo`` 4.0.1 -> 4.0.2
| ``terser-webpack-plugin`` 5.5.0 -> 5.6.1
| ``typescript-eslint`` 8.59.0 -> 8.65.0
| ``webpack`` 5.106.2 -> 5.108.4
| ``webpack-bundle-analyzer`` 5.3.0 -> 5.3.1
| ``zustand`` 5.0.12 -> 5.0.14
| Transitive advisory bumps: ``brace-expansion``, ``form-data``, ``undici``, ``js-yaml``
| Reverted ``azure-mgmt-resource`` to avoid a breaking import-path change in ``pgadmin/misc/cloud/azure``
JavaScript (``runtime/``):
| ``electron`` 42.3.3 -> 43.1.1
| ``eslint`` 10.4.1 -> 10.7.0
| ``globals`` 17.6.0 -> 17.7.0
| ``axios`` 1.18.0 -> 1.18.1
| ``ip-address`` 10.1.1 -> 10.2.0
| ``postcss`` 8.5.10 -> 8.5.20
| Pinned ``packageManager`` to ``yarn@4.15.0``
+136
View File
@@ -0,0 +1,136 @@
************
Version 9.18
************
Release date: 2026-09-17
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.17.
Supported Database Servers
**************************
**PostgreSQL**: 14, 15, 16, 17 and 18
**EDB Advanced Server**: 14, 15, 16, 17 and 18
Bundled PostgreSQL Utilities
****************************
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.4
New features
************
| `Issue #9631 <https://github.com/pgadmin-org/pgadmin4/issues/9631>`_ - Collapse and restore the Object Explorer by re-clicking the current workspace icon, in the manner of the VS Code side bar, remembering the choice across refreshes. A keyboard shortcut, Ctrl+Alt+B by default, does the same thing and can be changed through the new ``toggle_object_explorer`` preference.
Housekeeping
************
| `Issue #10221 <https://github.com/pgadmin-org/pgadmin4/issues/10221>`_ - Skip importing and initialising the kerberos, ldap, mfa, oauth2 and webserver authentication providers unless ``SERVER_MODE`` is set, leaving desktop mode with internal authentication alone.
| `Issue #10247 <https://github.com/pgadmin-org/pgadmin4/issues/10247>`_ - Relax the ``azure-mgmt-resource`` pin to allow 24.0.0, and aggregate the third-party JavaScript and Python dependency bumps for this release.
| `Issue #10293 <https://github.com/pgadmin-org/pgadmin4/issues/10293>`_ - Make the Schema Diff regression test assert its own generated script, which it previously swallowed, so invalid generated SQL can no longer pass silently.
Bug fixes
*********
| `Issue #9226 <https://github.com/pgadmin-org/pgadmin4/issues/9226>`_ - Accept ``SharedUsername`` when importing a shared server from a servers.json definition, instead of insisting on ``Username`` for every server.
| `Issue #10155 <https://github.com/pgadmin-org/pgadmin4/issues/10155>`_ - Share concurrent identical GET requests behind ``getNodeAjaxOptions()`` so a wide table's Columns tab no longer fires one duplicate ``get_types`` request per column row.
| `Issue #10179 <https://github.com/pgadmin-org/pgadmin4/issues/10179>`_ - Fix inherited columns in the Table dialog being editable and deletable: a column already inherited from a parent carries ``inheritedfromtable`` while one fetched interactively through 'Inherited from table(s)' carries ``inheritedfrom`` and has no ``attnum`` yet, and only the latter was checked, after an ``isNew()`` short-circuit that treated the attnum-less rows as new.
| `Issue #10180 <https://github.com/pgadmin-org/pgadmin4/issues/10180>`_ - Fix the Data type dropdown on the expanded Definition tab of the Table dialog offering every type, ignoring the allowed-type restriction already applied to the inline editor.
| `Issue #10214 <https://github.com/pgadmin-org/pgadmin4/issues/10214>`_ - Fix the ``existingSecret`` path in the Helm deployment template.
| `Issue #10235 <https://github.com/pgadmin-org/pgadmin4/issues/10235>`_ - Remove a trailing quote from the Windows installer's ``ProductVersion``, which was stamped as e.g. ``9.17"``.
| `Issue #10236 <https://github.com/pgadmin-org/pgadmin4/issues/10236>`_ - Fix Schema Diff reporting false differences for SERIAL/BIGSERIAL columns by ignoring the owned sequence's oid, and fix the invalid ``ALTER COLUMN ... TYPE bigserial`` SQL generated when such a column genuinely differs.
| `Issue #10237 <https://github.com/pgadmin-org/pgadmin4/issues/10237>`_ - Fix a ``replace() argument 2 must be str, not None`` crash when a per-server Password Exec Command is used with a service-only (pg_service.conf) connection, which leaves host, port and username unset.
| `Issue #10239 <https://github.com/pgadmin-org/pgadmin4/issues/10239>`_ - Remove a redundant ``passlib`` pin that conflicts with the indirectly required ``libpass``.
| `Issue #10252 <https://github.com/pgadmin-org/pgadmin4/issues/10252>`_ - Fix the argument grid on the Definition tab of a user-defined function or procedure refusing to delete, or add, a row in edit mode.
| `Issue #10295 <https://github.com/pgadmin-org/pgadmin4/issues/10295>`_ - Reinstate dependency ordering of the script Schema Diff generates, which had been lost since the React port left ``dependLevel`` unset.
| `Issue #10297 <https://github.com/pgadmin-org/pgadmin4/issues/10297>`_ - Fix Schema Diff duplicating any column that also differs when it recreates a foreign table.
| `Issue #10298 <https://github.com/pgadmin-org/pgadmin4/issues/10298>`_ - Fix Schema Diff generating SQL that PostgreSQL rejects when a sequence's MINVALUE is raised above its current value.
| `Issue #10300 <https://github.com/pgadmin-org/pgadmin4/issues/10300>`_ - Fix a foreign table column added by Schema Diff losing its collation.
| `Issue #10302 <https://github.com/pgadmin-org/pgadmin4/issues/10302>`_ - Fix Schema Diff injecting whitespace into an applied function or procedure body, which left a whitespace-only difference behind.
| `Issue #10303 <https://github.com/pgadmin-org/pgadmin4/issues/10303>`_ - Report a Schema Diff comparison that fails part way through as a failure, rather than as a success.
| `Issue #10309 <https://github.com/pgadmin-org/pgadmin4/issues/10309>`_ - Reject an empty or null ``Username`` when importing a non-shared server, which previously imported cleanly and left a server libpq would silently authenticate as the OS account running pgAdmin.
| `Issue #10311 <https://github.com/pgadmin-org/pgadmin4/issues/10311>`_ - Fix login being impossible against Flask-Security-Too 5.8.2, which corrected a long-standing inversion in ``UserMixin.is_locked()`` that ``User.is_locked()`` had been written against.
| `Issue #10341 <https://github.com/pgadmin-org/pgadmin4/issues/10341>`_ - Omit the redundant ``TABLESPACE pg_default`` clause from generated index SQL, which was invalid on a partitioned table.
| `Issue #10383 <https://github.com/pgadmin-org/pgadmin4/issues/10383>`_ - Fix an authentication bypass in Webserver authentication mode, where ``get_user()`` fell back to reading the configured ``WEBSERVER_REMOTE_USER`` name from the request headers when it was absent from the WSGI environment, letting any client that could reach pgAdmin assert any identity, including an administrator's (CVE-2026-86863). Header-asserted identity is now opt-in, restricted to a configured list of trusted proxies with an optional shared secret, and refused for accounts whose authentication source is not ``webserver``. Reported by Sanghyeon Lee (@h9e0n).
| `Issue #10384 <https://github.com/pgadmin-org/pgadmin4/issues/10384>`_ - Fix argument and connection-string injection in the Backup tool, where the client-supplied database name was appended to the pg_dump argument vector as a bare positional argument: because getopt_long permutes arguments, a value beginning with a dash supplied further options such as ``--file``, overriding the storage-confined output path, and because libpq expands a database name containing an equals sign into a full connection string, one could also redirect the connection to an attacker-controlled host and exfiltrate the stored password (CVE-2026-86864). The database name is now passed through the ``PGDATABASE`` environment variable instead. Reported by Sanghyeon Lee (@h9e0n) and Hitesh Jambhale.
| `Issue #10385 <https://github.com/pgadmin-org/pgadmin4/issues/10385>`_ - Fix a time-of-check to time-of-use flaw in the File Manager's ``save_file`` endpoint, which backs saving from the Query Tool and ERD: the requested path was validated with ``check_access_permission()`` and then opened with a plain ``open()``, so a symbolic link planted in between was followed, writing outside the storage directory. This is the sink CVE-2026-7819's hardening of the separate upload path did not cover (CVE-2026-86861). Reported by sec-rex.
| `Issue #10388 <https://github.com/pgadmin-org/pgadmin4/issues/10388>`_ - Fix connection-string injection in the Restore and Maintenance tools, where the client-supplied database name was passed straight to ``--dbname``: libpq expands a database name containing an equals sign into a full connection string, whose embedded keywords override the ``--host`` and ``--port`` pgAdmin supplies, so the connection - and the stored password exported in ``PGPASSWORD`` - could be redirected to a server of the caller's choosing (CVE-2026-86862). The database name is now passed through the ``PGDATABASE`` environment variable, which libpq never expands. Found by Hitesh Jambhale.
| `Issue #10393 <https://github.com/pgadmin-org/pgadmin4/issues/10393>`_ - Render the Validate binary path dialog as HTML, instead of showing the raw markup.
| `Issue #10420 <https://github.com/pgadmin-org/pgadmin4/issues/10420>`_ - Refuse HTTP redirects on LLM API requests, rather than following a ``Location`` header on to a destination ``ALLOWED_LLM_API_URLS`` was never applied to. This is hardening rather than a fix for an exploitable flaw, since returning the redirect at all requires control of a host already on the allowlist. Reported by Ziya Abdullayev.
Dependencies
************
Non-breaking ``dependabot`` and audit-driven bumps aggregated for v9.18.
Python:
| ``Authlib`` 1.7.* -> 1.8.*
| ``azure-mgmt-resource`` ==25.0.0 -> >=24.0.0,<26.0.0
| ``certifi`` 2026.6.17 -> 2026.7.22
| ``cryptography`` 49.0.* -> 50.0.*
| ``Flask-Security-Too`` 5.8.* -> >=5.8.2,<5.9
| ``google-auth-oauthlib`` 1.4.0 -> 1.4.1
| ``gssapi`` 1.11.* -> 1.12.*
| ``passlib`` 1.* pin removed (redundant, and conflicting with ``libpass``)
| ``psycopg[c]`` 3.3.4 -> 3.3.5
| ``selenium`` (``web/regression``) 4.45.0 -> 4.48.0
| ``setuptools`` 83.* -> 84.*
| ``testscenarios`` (``web/regression``) 0.6.2 -> 0.7.0
| ``typer`` 0.26.* -> 0.27.*
| Skipped: ``paramiko`` 3 -> 5 (blocked on ``sshtunnel``'s ``paramiko.DSSKey`` usage) and ``azure-mgmt-resource`` 26.0.0 (drops Python 3.9 support)
JavaScript (``web/``):
| ``@babel/*`` toolchain (core, eslint-parser, eslint-plugin, plugin-syntax-jsx, plugin-transform-class-properties, plugin-transform-object-rest-spread, plugin-transform-runtime, preset-env, preset-react, preset-typescript) -> 7.29.7
| ``@mui/icons-material`` / ``@mui/material`` 7.3.10 -> 7.3.11
| ``@mui/x-date-pickers`` 8.28.3 -> 8.29.3
| ``@tanstack/react-query`` 5.101.4 -> 5.102.8
| ``@tanstack/react-virtual`` 3.13.24 -> 3.14.10
| ``@testing-library/jest-dom`` 6.9.1 -> 6.10.0
| ``@testing-library/react`` 16.3.2 -> 16.3.3
| ``@testing-library/user-event`` 14.6.1 -> 14.6.3
| ``@types/react`` 19.2.17 -> 19.2.18
| ``@types/react-dom`` 19.2.3 -> 19.2.5
| ``anti-trojan-source`` 1.12.0 -> 1.12.2
| ``axios`` 1.18.1 -> 1.20.0
| ``codemirror`` 6.0.2 -> 6.65.7
| ``core-js`` 3.49.0 -> 3.50.0
| ``css-loader`` 7.1.4 -> 7.1.5
| ``diff-arrays-of-objects`` 1.1.10 -> 1.1.11
| ``dompurify`` 3.4.12 -> 3.4.14
| ``eslint`` 9.39.4 -> 9.39.5
| ``eslint-plugin-jest`` 29.15.5 -> 29.16.6
| ``globals`` 17.7.0 -> 17.12.0
| ``hotkeys-js`` 4.0.4 -> 4.0.7
| ``image-minimizer-webpack-plugin`` 4.1.4 -> 5.0.0
| ``ip-address`` 10.2.0 -> 10.7.0
| ``jest`` / ``jest-environment-jsdom`` 30.4.2 / 30.4.1 -> 30.5.1
| ``lossless-json`` 4.3.0 -> 4.3.1
| ``marked`` 18.0.7 -> 18.0.11
| ``papaparse`` 5.5.4 -> 5.7.0
| ``postcss`` 8.5.20 -> 8.5.26
| ``rc-dock`` 4.0.0-alpha.2 -> 4.0.0-alpha.3
| ``react`` / ``react-dom`` 19.2.7 -> 19.2.8
| ``react-arborist`` 3.5.0 -> 3.16.0
| ``react-draggable`` 4.7.0 -> 4.7.1
| ``sharp`` 0.35.3 -> 0.35.4
| ``svgo`` 4.0.2 -> 4.1.0
| ``svgo-loader`` 4.0.0 -> 5.0.0
| ``typescript-eslint`` 8.65.0 -> 8.69.0
| ``use-resize-observer`` 9.1.0 -> 10.0.0
| ``vanilla-jsoneditor`` 3.12.0 -> 3.13.0
| ``webpack-bundle-analyzer`` 5.3.1 -> 5.3.2
| ``zustand`` 5.0.14 -> 5.0.15
| Transitive advisory bumps: ``brace-expansion``, ``fast-uri``, ``js-yaml``, ``shell-quote``, ``socket.io-parser``, ``tar``
| Held back: ``@simonwep/pickr`` 1.10.x (webpack production-bundle interop break), Babel 8, and ``webpack`` 5.110.3 (npm-quarantined at bump time)
JavaScript (``runtime/``):
| ``axios`` 1.18.1 -> 1.19.0
| ``electron`` 43.1.1 -> 43.4.0
| ``eslint`` 10.7.0 -> 10.8.1
| ``globals`` 17.7.0 -> 17.11.0
| ``ip-address`` 10.2.0 -> 10.3.1
| ``postcss`` 8.5.20 -> 8.5.23
| Transitive advisory bumps: ``brace-expansion``, ``fast-uri``, ``undici``
+196
View File
@@ -0,0 +1,196 @@
************
Version 9.19
************
Release date: 2026-10-29
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.18.
.. warning:: In server mode, free-text Password Exec Commands are no longer
run, and ``ENABLE_SERVER_PASS_EXEC_CMD`` is deprecated and ignored.
Administrators now define the permitted commands by name in
``SERVER_PASSEXEC_COMMANDS``, and users choose one of those names in the
server properties. Configure ``SERVER_PASSEXEC_COMMANDS`` **before** the
first start after upgrading: on that start, each existing command that
exactly matches a configured entry is converted to its name, and every
other command is cleared, which cannot be undone. If the setting is empty,
the conversion is postponed and a warning is logged at each start. See
``config.py`` and the server dialog documentation for details.
.. note:: Users who do not own a shared server never inherit the owner's
password file; it is treated like the owner's password, SSH key and SSL
client files. Each user can set their own password file on their copy of
the server, and a file that everyone should use can be placed in a
``SHARED_STORAGE`` directory and referenced as ``Name:/.pgpass``.
.. note:: In desktop mode, when an SSH tunnel is configured with an identity
file or a password, pgAdmin no longer also offers keys from the SSH agent;
the agent is still used when neither is configured. In server mode, SSH
tunnels never use the SSH agent, or the keys and configuration in the
``~/.ssh`` directory of the account pgAdmin runs as, so a tunnel that
relied on them must be given an identity file or password on the server.
.. note:: On Python 3.10 and later, pgAdmin now requires Flask-Security-Too
5.8.3 or later, which fixes an open redirect (GHSA-ccgp-pv8r-95wm). This
matters to anyone installing pgAdmin from the Python wheel into an
existing environment. Python 3.9 installations remain on the
Flask-Security-Too 5.6 series.
Supported Database Servers
**************************
**PostgreSQL**: 14, 15, 16, 17 and 18
**EDB Advanced Server**: 14, 15, 16, 17 and 18
Bundled PostgreSQL Utilities
****************************
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.6
New features
************
| `Issue #2018 <https://github.com/pgadmin-org/pgadmin4/issues/2018>`_ - Add a Statistics node for creating and managing extended statistics.
| `Issue #2363 <https://github.com/pgadmin-org/pgadmin4/issues/2363>`_ - Allow data to be edited through simple auto-updatable views in View/Edit Data.
| `Issue #3205 <https://github.com/pgadmin-org/pgadmin4/issues/3205>`_ - Allow Query Tool results to be saved as JSON or XML, as well as CSV.
| `Issue #3834 <https://github.com/pgadmin-org/pgadmin4/issues/3834>`_ - Add a keyboard shortcut to duplicate the current line or selection in the SQL editor.
| `Issue #4128 <https://github.com/pgadmin-org/pgadmin4/issues/4128>`_ - Allow the encoding of Query Tool result files to be chosen.
| `Issue #4129 <https://github.com/pgadmin-org/pgadmin4/issues/4129>`_ - Add a 'copy with headers' option for Query Tool results.
| `Issue #5691 <https://github.com/pgadmin-org/pgadmin4/issues/5691>`_ - Close dialogs with the Escape key.
| `Issue #6695 <https://github.com/pgadmin-org/pgadmin4/issues/6695>`_ - Allow a byte order mark to be added to Query Tool result files.
| `Issue #7167 <https://github.com/pgadmin-org/pgadmin4/issues/7167>`_ - Allow dialogs such as Sort/Filter to be saved and closed with the Enter key.
| `Issue #8647 <https://github.com/pgadmin-org/pgadmin4/issues/8647>`_ - Allow shift + click to extend the cell range selection in the Query Tool results grid.
| `Issue #9057 <https://github.com/pgadmin-org/pgadmin4/issues/9057>`_ - Support UNLOGGED partitioned tables correctly, which PostgreSQL 18 no longer allows to be created or altered.
| `Issue #9064 <https://github.com/pgadmin-org/pgadmin4/issues/9064>`_ - Add the PostgreSQL 18 pg_dump options to the Backup and Backup Server dialogs.
| `Issue #9066 <https://github.com/pgadmin-org/pgadmin4/issues/9066>`_ - Add the PostgreSQL 18 pg_restore options to the Restore dialog.
| `Issue #9212 <https://github.com/pgadmin-org/pgadmin4/issues/9212>`_ - Show fill factor, TOAST tuple target and parallel workers in the table Properties panel.
| `Issue #9264 <https://github.com/pgadmin-org/pgadmin4/issues/9264>`_ - Move the 'Returns a set?' option to the Definition tab in the Function dialog.
| `Issue #9704 <https://github.com/pgadmin-org/pgadmin4/issues/9704>`_ - Allow an OAuth2 claim to restrict which shared servers a user can see, configured through ``OAUTH2_SERVER_GROUP_CLAIM`` and ``OAUTH2_SERVER_GROUP_CLAIM_MAPPING``.
| `Issue #9975 <https://github.com/pgadmin-org/pgadmin4/issues/9975>`_ - Allow the login page to be skipped when OAuth2 is the only authentication source, using ``OAUTH2_AUTO_LOGIN`` and ``OAUTH2_LOGOUT_URL``.
| `Issue #10148 <https://github.com/pgadmin-org/pgadmin4/issues/10148>`_ - Add support for managing pg_timetable chains and tasks.
| `Issue #10249 <https://github.com/pgadmin-org/pgadmin4/issues/10249>`_ - Replace free-text Password Exec Commands in server mode with an administrator-defined allowlist, ``SERVER_PASSEXEC_COMMANDS``. Commands run without a shell, with a reduced environment, and receive the pgAdmin user's identity in ``PGADMIN_PASSEXEC_*`` variables; users of a shared server inherit the owner's command by default.
| `Issue #10473 <https://github.com/pgadmin-org/pgadmin4/issues/10473>`_ - Add a macOS 26 layered app icon with dark, clear and tinted variants.
| `Issue #10499 <https://github.com/pgadmin-org/pgadmin4/issues/10499>`_ - Add pgEdge Starfleet to the Deploy Cloud Instance wizard, for creating Starfleet Managed databases.
| `Issue #10503 <https://github.com/pgadmin-org/pgadmin4/issues/10503>`_ - Add numpad zoom shortcuts to the Desktop View menu.
Housekeeping
************
| `Issue #5369 <https://github.com/pgadmin-org/pgadmin4/issues/5369>`_ - Clarify the configuration files documentation.
| `Issue #9230 <https://github.com/pgadmin-org/pgadmin4/issues/9230>`_ - Rename the server 'Change Password' option to 'Change Server Password', and the user menu option to 'Change pgAdmin Password', so the two can no longer be confused.
| `Issue #9331 <https://github.com/pgadmin-org/pgadmin4/issues/9331>`_ - Remove unused Google API documents, Babel locale data and packaging tools from the packages.
| `Issue #9524 <https://github.com/pgadmin-org/pgadmin4/issues/9524>`_ - Document running the container with rootless Podman, and the ``PUID`` and ``PGID`` environment variables.
| `Issue #10363 <https://github.com/pgadmin-org/pgadmin4/issues/10363>`_ - Enforce ``--immutable`` on every yarn install, in CI and the release builds, to harden the supply chain.
| `Issue #10546 <https://github.com/pgadmin-org/pgadmin4/issues/10546>`_ - Fix the flaky ``test_windows_pty_failures`` test counting psql output from other tests.
| `Issue #10552 <https://github.com/pgadmin-org/pgadmin4/issues/10552>`_ - Add a test for Reset discarding pending SQL editor values in dialogs.
| `Issue #10553 <https://github.com/pgadmin-org/pgadmin4/issues/10553>`_ - Make the server tests restore the shared test fixture after themselves.
| `Issue #10601 <https://github.com/pgadmin-org/pgadmin4/issues/10601>`_ - Remove the dead tree ``loadfail`` handler from ``browser.js``.
| `Issue #10602 <https://github.com/pgadmin-org/pgadmin4/issues/10602>`_ - Fix the Jest ``addNewDatagridRow`` helper so schema UI specs actually add a row.
Bug fixes
*********
| `Issue #5940 <https://github.com/pgadmin-org/pgadmin4/issues/5940>`_ - Fix View/Edit Data failing on SQL_ASCII databases when a name contains a backslash followed by 'u' or 'U'.
| `Issue #6090 <https://github.com/pgadmin-org/pgadmin4/issues/6090>`_ - Refresh a stale server connection manager when a server id is reused, so one user's session can no longer pick up settings from another server.
| `Issue #6231 <https://github.com/pgadmin-org/pgadmin4/issues/6231>`_ - Generate a single GRANT statement for roles with identical privileges.
| `Issue #6481 <https://github.com/pgadmin-org/pgadmin4/issues/6481>`_ - Fix index and constraint columns not being shown when their names require quoting.
| `Issue #6652 <https://github.com/pgadmin-org/pgadmin4/issues/6652>`_ - Fix Schema Diff treating functions that differ only in OUT arguments or return type as unrelated objects.
| `Issue #6671 <https://github.com/pgadmin-org/pgadmin4/issues/6671>`_ - Allow the emailed MFA code to be re-entered after an invalid code is entered.
| `Issue #7232 <https://github.com/pgadmin-org/pgadmin4/issues/7232>`_ - Fix the tab switching shortcuts not working whilst focus is inside the PSQL, Query, ERD or Schema Diff tools.
| `Issue #7612 <https://github.com/pgadmin-org/pgadmin4/issues/7612>`_ - Fix the server context menu showing database options after the tree state is restored.
| `Issue #7619 <https://github.com/pgadmin-org/pgadmin4/issues/7619>`_ - Fix Query Tool autocomplete running as the wrong user, or failing, after changing the connection to a different user.
| `Issue #8015 <https://github.com/pgadmin-org/pgadmin4/issues/8015>`_ - Re-sort renamed server groups and other nodes in the Object Explorer instead of waiting for a reload.
| `Issue #8144 <https://github.com/pgadmin-org/pgadmin4/issues/8144>`_ - Connect the server when changing the Query Tool connection after it was disconnected.
| `Issue #8529 <https://github.com/pgadmin-org/pgadmin4/issues/8529>`_ - Rewrite the container entrypoint using bash features, and pass values to the embedded Python safely, so an email address containing an apostrophe works and a validation error stops the container rather than passing silently.
| `Issue #8664 <https://github.com/pgadmin-org/pgadmin4/issues/8664>`_ - Fix debugger messages from successive steps running together on one line.
| `Issue #8991 <https://github.com/pgadmin-org/pgadmin4/issues/8991>`_ - Fix BEGIN, COMMIT and ROLLBACK silently failing in the Query Tool under server cursor mode.
| `Issue #9130 <https://github.com/pgadmin-org/pgadmin4/issues/9130>`_ - Select the adjacent tab when the active tab is closed, rather than the left-most.
| `Issue #9450 <https://github.com/pgadmin-org/pgadmin4/issues/9450>`_ - Allow roles holding ADMIN OPTION to manage Group Role membership.
| `Issue #9603 <https://github.com/pgadmin-org/pgadmin4/issues/9603>`_ - Restore the per-tab toolbar options when Query Tool tabs are restored on relaunch.
| `Issue #9624 <https://github.com/pgadmin-org/pgadmin4/issues/9624>`_ - Fix a database's label staying at '[Disconnecting...]' when disconnecting it fails.
| `Issue #9630 <https://github.com/pgadmin-org/pgadmin4/issues/9630>`_ - Fix the parameter value dropdown keeping stale options when the parameter name is changed.
| `Issue #9672 <https://github.com/pgadmin-org/pgadmin4/issues/9672>`_ - Fix View/Edit Data not handling generated columns properly.
| `Issue #9784 <https://github.com/pgadmin-org/pgadmin4/issues/9784>`_ - Fix modal dialogs losing keyboard focus to a tool iframe loading in the background.
| `Issue #9798 <https://github.com/pgadmin-org/pgadmin4/issues/9798>`_ - Fix the collation and ctype query error for databases with a non-default LC_COLLATE.
| `Issue #9814 <https://github.com/pgadmin-org/pgadmin4/issues/9814>`_ - Disable the SSH agent when an SSH tunnel identity file or password is provided.
| `Issue #9818 <https://github.com/pgadmin-org/pgadmin4/issues/9818>`_ - Keep the AI Assistant's intermediate responses instead of replacing them with placeholder messages.
| `Issue #9836 <https://github.com/pgadmin-org/pgadmin4/issues/9836>`_ - Fix the CREATE TABLE script ignoring the UNLOGGED attribute of a partition.
| `Issue #9838 <https://github.com/pgadmin-org/pgadmin4/issues/9838>`_ - Fix formatting a view's SQL being treated as a column change that drops and re-creates the view.
| `Issue #9865 <https://github.com/pgadmin-org/pgadmin4/issues/9865>`_ - Fix modal dialogs being hidden from assistive technology by ``aria-hidden`` on the application root.
| `Issue #9890 <https://github.com/pgadmin-org/pgadmin4/issues/9890>`_ - Fix ERD tables becoming immovable after a Shift-drag selection.
| `Issue #9921 <https://github.com/pgadmin-org/pgadmin4/issues/9921>`_ - Fix Azure and Google authentication in the cloud deployment wizard.
| `Issue #9984 <https://github.com/pgadmin-org/pgadmin4/issues/9984>`_ - Report an unreachable external configuration database, or a malformed ``CONFIG_DATABASE_URI``, as a failed check rather than an unhandled exception.
| `Issue #10031 <https://github.com/pgadmin-org/pgadmin4/issues/10031>`_ - Fix Query Tool tabs running their query automatically after a session restore.
| `Issue #10103 <https://github.com/pgadmin-org/pgadmin4/issues/10103>`_ - Exclude non-editable alias and expression columns when saving edited rows in the Query Tool.
| `Issue #10136 <https://github.com/pgadmin-org/pgadmin4/issues/10136>`_ - Restore tags for standard users on shared servers, and never inherit the owner's password file.
| `Issue #10143 <https://github.com/pgadmin-org/pgadmin4/issues/10143>`_ - Fix switching back to a dialog tab containing a data grid being slow, by skipping virtualisation for small grids.
| `Issue #10226 <https://github.com/pgadmin-org/pgadmin4/issues/10226>`_ - Restore remembering the last visited directory in the desktop file dialogs.
| `Issue #10251 <https://github.com/pgadmin-org/pgadmin4/issues/10251>`_ - Fix invalid SQL from the Maintenance dialog for REINDEX ... CONCURRENTLY.
| `Issue #10254 <https://github.com/pgadmin-org/pgadmin4/issues/10254>`_ - Fix the Object Explorer shortcut not moving keyboard focus into the tree.
| `Issue #10273 <https://github.com/pgadmin-org/pgadmin4/issues/10273>`_ - Fix the dashboard transactions per second graph being wrong for refresh rates other than one second.
| `Issue #10292 <https://github.com/pgadmin-org/pgadmin4/issues/10292>`_ - Fix Schema Diff scripts that convert a column to or from SERIAL.
| `Issue #10301 <https://github.com/pgadmin-org/pgadmin4/issues/10301>`_ - Drop the scaffolding default partition after Schema Diff rebuilds a partitioned table.
| `Issue #10310 <https://github.com/pgadmin-org/pgadmin4/issues/10310>`_ - Fix the Statistics node failing to list its children in Object Explorer.
| `Issue #10334 <https://github.com/pgadmin-org/pgadmin4/issues/10334>`_ - Add Caddy reverse proxy configuration examples to the documentation.
| `Issue #10347 <https://github.com/pgadmin-org/pgadmin4/issues/10347>`_ - Fix the selected UI language not persisting beyond the request that set it in server mode.
| `Issue #10348 <https://github.com/pgadmin-org/pgadmin4/issues/10348>`_ - Fix OpenAI streaming tool calls being split into two entries in the AI Assistant.
| `Issue #10349 <https://github.com/pgadmin-org/pgadmin4/issues/10349>`_ - Fix the OAuth2 userinfo request crashing when ``OAUTH2_USERINFO_ENDPOINT`` is set to None.
| `Issue #10350 <https://github.com/pgadmin-org/pgadmin4/issues/10350>`_ - Fix the MAINTAIN privilege being silently dropped for views and materialised views on PostgreSQL 17 and later.
| `Issue #10357 <https://github.com/pgadmin-org/pgadmin4/issues/10357>`_ - Fix the cursor jumping to the start of SQL fields in dialogs when keys are pressed together.
| `Issue #10364 <https://github.com/pgadmin-org/pgadmin4/issues/10364>`_ - Explain Docker Compose quoting for ``PGADMIN_CONFIG_*`` values in the container documentation.
| `Issue #10386 <https://github.com/pgadmin-org/pgadmin4/issues/10386>`_ - Stop the Query Tool spinner, and its idle CPU use, whilst a password prompt is open.
| `Issue #10401 <https://github.com/pgadmin-org/pgadmin4/issues/10401>`_ - Show default privileges in the Database properties panel.
| `Issue #10409 <https://github.com/pgadmin-org/pgadmin4/issues/10409>`_ - Include the authenticated user in the access log on logout.
| `Issue #10414 <https://github.com/pgadmin-org/pgadmin4/issues/10414>`_ - Fix the Linux packages shipping a stray copy of Python as ``venv/bin/python``, which stopped the DEB package installing on Ubuntu 26.04.
| `Issue #10415 <https://github.com/pgadmin-org/pgadmin4/issues/10415>`_ - Prefer the user's email address as the Gravatar identifier.
| `Issue #10418 <https://github.com/pgadmin-org/pgadmin4/issues/10418>`_ - Remove the dead ``usr`` parameter from Query Tool connection URLs.
| `Issue #10419 <https://github.com/pgadmin-org/pgadmin4/issues/10419>`_ - Fix Kerberos login failures returning a JSON 500 response, and first-time automatically created Kerberos logins being rejected.
| `Issue #10422 <https://github.com/pgadmin-org/pgadmin4/issues/10422>`_ - Fix Schema Diff repeating unchanged column comments and identity options.
| `Issue #10424 <https://github.com/pgadmin-org/pgadmin4/issues/10424>`_ - Fix Reset Layout dropping Query Tool tabs from the saved application state.
| `Issue #10428 <https://github.com/pgadmin-org/pgadmin4/issues/10428>`_ - Fix connections crashing on Windows with an access violation, and the utilities failing to find ``gssapi64.dll``, by staging the Kerberos runtime next to libpq.
| `Issue #10446 <https://github.com/pgadmin-org/pgadmin4/issues/10446>`_ - Fix Schema Diff reporting identical tables as different when a foreign key's referenced table has a dropped column.
| `Issue #10449 <https://github.com/pgadmin-org/pgadmin4/issues/10449>`_ - Honour the password file in the Change Server Password dialog, rather than requiring the current password.
| `Issue #10462 <https://github.com/pgadmin-org/pgadmin4/issues/10462>`_ - Fix duplicated content when opening large non-UTF-8 files in the Query Tool.
| `Issue #10463 <https://github.com/pgadmin-org/pgadmin4/issues/10463>`_ - Pass the target database, and every supported connection parameter, to the utilities, so a database set in a service file no longer overrides the one selected.
| `Issue #10470 <https://github.com/pgadmin-org/pgadmin4/issues/10470>`_ - Remove inherited columns from the Columns tab when their parent table is removed after reopening a table.
| `Issue #10482 <https://github.com/pgadmin-org/pgadmin4/issues/10482>`_ - Allow saving files through symbolic links in desktop mode, and stop forcing 0600 permissions on them there.
| `Issue #10485 <https://github.com/pgadmin-org/pgadmin4/issues/10485>`_ - Fix 'Cannot have two HTML5 backends at the same time' errors in dialogs containing a data grid.
| `Issue #10511 <https://github.com/pgadmin-org/pgadmin4/issues/10511>`_ - Fix the Dashboard Logs tab failing on multi-byte characters split across read chunks.
| `Issue #10527 <https://github.com/pgadmin-org/pgadmin4/issues/10527>`_ - Write the cloud deployment wizard's AWS, Azure and Google credentials through to the session store.
| `Issue #10531 <https://github.com/pgadmin-org/pgadmin4/issues/10531>`_ - Fix the Query Tool saving files that were loaded as latin-1 back as UTF-8.
| `Issue #10534 <https://github.com/pgadmin-org/pgadmin4/issues/10534>`_ - Fix the hardcoded table OID in the column properties query, which broke inherited column details.
| `Issue #10547 <https://github.com/pgadmin-org/pgadmin4/issues/10547>`_ - Fix valid escapes below U+0100 being rewritten in SQL_ASCII data and names.
| `Issue #10548 <https://github.com/pgadmin-org/pgadmin4/issues/10548>`_ - Fix negative identity column options being dropped from the generated SQL.
| `Issue #10549 <https://github.com/pgadmin-org/pgadmin4/issues/10549>`_ - Fix Schema Diff not removing a column comment that exists only in the target.
| `Issue #10550 <https://github.com/pgadmin-org/pgadmin4/issues/10550>`_ - Fix changing an identity column's START value also restarting its sequence.
| `Issue #10551 <https://github.com/pgadmin-org/pgadmin4/issues/10551>`_ - Fix the cursor jumping to the start of SQL fields in dialogs after a quick edit and undo.
| `Issue #10554 <https://github.com/pgadmin-org/pgadmin4/issues/10554>`_ - Fix column properties reporting an arbitrary parent for columns merged from several parents.
| `Issue #10573 <https://github.com/pgadmin-org/pgadmin4/issues/10573>`_ - Fix Query Tool state save/restore failing on installations with a legacy ``SECRET_KEY``.
| `Issue #10584 <https://github.com/pgadmin-org/pgadmin4/issues/10584>`_ - Preserve explicit 24-hour mode in date-time picker popups.
| `Issue #10597 <https://github.com/pgadmin-org/pgadmin4/issues/10597>`_ - Fix Schema Diff treating a function whose input argument was renamed as two unrelated functions.
| `Issue #10598 <https://github.com/pgadmin-org/pgadmin4/issues/10598>`_ - Keep the Query Tool execute options when its transaction is re-created.
| `Issue #10600 <https://github.com/pgadmin-org/pgadmin4/issues/10600>`_ - Revert the Query Tool execute option checkboxes when changing an option fails.
| `Issue #10603 <https://github.com/pgadmin-org/pgadmin4/issues/10603>`_ - Fix the Query Tool not re-running the query after reconnecting at a password prompt.
| `Issue #10604 <https://github.com/pgadmin-org/pgadmin4/issues/10604>`_ - Report a failed autocomplete reconnect in the Query Tool instead of ignoring it.
| `Issue #10607 <https://github.com/pgadmin-org/pgadmin4/issues/10607>`_ - Fix Query Tool autocomplete objects being shared between sessions that use the same transaction id.
| `Issue #10612 <https://github.com/pgadmin-org/pgadmin4/issues/10612>`_ - Free Query Tool autocomplete objects when an idle session's connections are released.
| `Issue #10613 <https://github.com/pgadmin-org/pgadmin4/issues/10613>`_ - Reconnect a lost Query Tool connection as the user and role it was changed to.
| `Issue #10614 <https://github.com/pgadmin-org/pgadmin4/issues/10614>`_ - Keep external pages out of the desktop runtime's privileged windows and confine non-prompted downloads to the downloads directory.
| `Issue #10618 <https://github.com/pgadmin-org/pgadmin4/issues/10618>`_ - Keep Query Tool execution disabled until a restored tab's execute options reach the server.
| `Issue #10645 <https://github.com/pgadmin-org/pgadmin4/issues/10645>`_ - Fix connection redirection in the materialized view refresh, where the target database's name was passed straight to psql's ``--dbname``: because libpq expands a value containing an equals sign into a full connection string, a database named like ``host=... port=...``, which any role with only CREATEDB can create, redirected psql to a server of the creator's choosing and leaked the connecting user's saved password (CVE-2026-116252). The name is now passed through the same connection-information helper as the Backup, Restore, Maintenance and Import/Export tools, so libpq treats it strictly as a database name. Reported by Bae Seung-won (@baeseungwon1010).
| `Issue #10646 <https://github.com/pgadmin-org/pgadmin4/issues/10646>`_ - Fix a user's other sessions surviving a password change, which left a session an attacker already held valid after the password was changed or reset (CVE-2026-116251). A self-service change now rotates the user's ``fs_uniquifier``, logging out every other session while the changing session stays signed in with its database connections, and saved passwords, including those of shared servers, are re-encrypted under the new key, with any that cannot be decrypted cleared, and all of them cleared if re-encryption fails. An administrator reset (including ``setup.py update-user``) also rotates ``fs_uniquifier``, ending all of that user's sessions, but does not re-encrypt their saved passwords. Reported by Zohaib.
| `Issue #10647 <https://github.com/pgadmin-org/pgadmin4/issues/10647>`_ - Fix time-of-check to time-of-use symlink races in Import/Export Servers and the File Manager's upload, save and file-open paths, where a path validated against the user's storage directory was then opened by name, so a symbolic link swapped in at the file or any parent directory in between let an export overwrite, or an import read, a file outside the storage directory (CVE-2026-116250). In server mode on POSIX the file is now opened by walking down from the storage directory one component at a time with ``O_NOFOLLOW``; new files are created with mode 0600 and only regular files are read, opened non-blocking so a FIFO cannot hang the request. Symbolic links inside a storage directory are now refused, even when they point elsewhere inside it. Windows and desktop mode are unchanged, so the race remains there. Reported by MUTED CYBERSECURITY S.L.
| `Issue #10648 <https://github.com/pgadmin-org/pgadmin4/issues/10648>`_ - Fix the same symlink races in the files handed to Backup, Restore and Import/Export Data, where the validated path was passed to pg_dump, pg_dumpall, pg_restore or psql, which opened it by name later, extending the fix for the vulnerability tracked in Issue #10647. In server mode on POSIX pgAdmin now opens the file itself with the descriptor-relative ``O_NOFOLLOW`` walk, accepts only a regular file and hands the utility ``/dev/fd/N``, and new backup and export files are created with mode 0600. This applies on Linux only, and not to directory-format Backup and Restore, where the utility opens the files inside the directory by name; on macOS and the BSDs the file is checked safely but the utility still reopens it by name.
| `Issue #10649 <https://github.com/pgadmin-org/pgadmin4/issues/10649>`_ - Refuse hard links and FIFOs in the symlink-race fixes of Issue #10647 and Issue #10648, since ``O_NOFOLLOW`` stops only symbolic links: in server mode on POSIX, a file with more than one link is refused, for reading as well as before it is truncated for writing, and a FIFO can no longer hang an upload, save or export; Windows is not covered. The Import/Export Servers, save, Backup, Restore and Import/Export Data handlers also return the reason for a failure instead of text containing the absolute storage path.
| `Issue #10650 <https://github.com/pgadmin-org/pgadmin4/issues/10650>`_ - Fix connection file paths escaping the user's storage directory, where a password file, SSL certificate, key or CRL, or SSH tunnel identity file such as ``../<another user>/.pgpass`` was joined to the storage directory after stripping only leading slashes, so a user could connect with another user's credentials or key, and where ``sslkeylogfile`` was copied into the connection string unchanged, letting libpq create or append a file as the pgAdmin service account (CVE-2026-116249). In server mode the resolved path, with symbolic links followed, must now stay inside the user's storage directory or the named shared storage directory, and ``sslkeylogfile`` is confined the same way. Connection parameter keys are also validated against the libpq keyword list, since a crafted key could smuggle its own ``keyword=value`` pairs past these checks. Servers whose file paths reach outside the storage directory, through ``..`` or a symbolic link, stop connecting until the files are moved into it or into a ``SHARED_STORAGE`` directory.
| `Issue #10651 <https://github.com/pgadmin-org/pgadmin4/issues/10651>`_ - Fix any user able to register a server being able to share it with every other user in server mode, because the create and update endpoints stored whatever ``shared`` value they were sent, and the servers.json import removed a non-administrator's shared entries only after validation, so an early error left them in place (CVE-2026-116248). Such requests are now refused with a 403, and the import prunes and skips a non-administrator's shared entries before validating. The restriction is not retroactive: servers shared by non-administrators before the upgrade stay shared until the owner un-shares them or an administrator clears the ``shared`` column in the configuration database, and pgAdmin only logs a warning about each of them at startup, so administrators should review those servers and un-share any that should not be shared. ``Shared`` in a servers.json import must now be the JSON value ``true``, and a file that fails validation is refused as a whole.
| `Issue #10652 <https://github.com/pgadmin-org/pgadmin4/issues/10652>`_ - Stop libpq using the pgAdmin service account's own client files in server mode: when a server had no password file, client certificate or client key configured, libpq fell back to the service account's ``~/.pgpass``, ``~/.postgresql/postgresql.crt`` and ``~/.postgresql/postgresql.key`` (or ``PGPASSFILE``, ``PGSSLCERT`` and ``PGSSLKEY``), letting any user connect with the service account's saved passwords or client certificate (CVE-2026-116247). In server mode each of these parameters is now always given a value, the user's own file or a path that can never be opened, in the connection string and for the utilities. Server mode deployments relying on the service account's files, or on ``passfile``, ``sslcert`` or ``sslkey`` in a connection service entry, must configure them on each server instead, and a server with a client certificate must also have a client key.
| `Issue #10653 <https://github.com/pgadmin-org/pgadmin4/issues/10653>`_ - Fix server passwords being left in pgAdmin's own process environment, where the password handed to psql and to the utilities was written into ``os.environ`` and never removed, so another user's later psql session or utility inherited it and libpq used it for any connection made without a password of its own (CVE-2026-116246). The password now goes only into the environment of the process that needs it.
| `Issue #10654 <https://github.com/pgadmin-org/pgadmin4/issues/10654>`_ - Restrict connection services in server mode, where any user could set a server's service, or a ``service`` connection parameter, to an entry in the service account's connection service file and connect with that entry's credentials, and where a ``PGPASSWORD`` or ``PGSERVICE`` variable set for that account was used for every connection (CVE-2026-116245). A service may now only be used if the administrator lists it in the new ``SERVER_MODE_ALLOWED_SERVICES`` setting, which is empty by default; the ``servicefile`` parameter is refused, and ``PGPASSWORD`` and ``PGSERVICE`` are removed from pgAdmin's environment at startup. ``setup.py load-servers`` also refuses an unlisted service. In server mode, servers that use a service stop connecting until the administrator lists it in ``SERVER_MODE_ALLOWED_SERVICES`` in ``config_local.py``, ideally before upgrading. Listing a service shares its credentials with every pgAdmin user, so list only services intended for everyone.
| `Issue #10655 <https://github.com/pgadmin-org/pgadmin4/issues/10655>`_ - Stop libpq using the pgAdmin service account's Kerberos credentials in server mode, where removing ``KRB5CCNAME`` let the Kerberos library fall back to the service account's default credential cache or client keytab (or its logon, through SSPI on Windows), so any user could answer a server's GSSAPI request as the service account's principal (CVE-2026-116244). In server mode ``KRB5CCNAME`` and ``KRB5_CLIENT_KTNAME`` now point at a file that cannot exist, except that a user who logged in with Kerberos gets their own delegated ``KRB5CCNAME`` when connecting to a server with Kerberos authentication enabled. Every other connection also gets ``gssencmode=disable`` and, with libpq 16 or later, ``require_auth=!gss,!sspi``; without ``require_auth``, SSPI and gssproxy are not stopped, so upgrade the libpq used by pgAdmin and its utilities to 16 or later. A server whose ``require_auth`` allows only GSSAPI or SSPI is refused unless the user logged in with Kerberos. A service listed in ``SERVER_MODE_ALLOWED_SERVICES`` takes precedence for psql and the utilities, so it must not set ``require_auth``, ``gssencmode`` or ``gsslib``.
| `Issue #10656 <https://github.com/pgadmin-org/pgadmin4/issues/10656>`_ - Fix the utility binary-path guard accepting a path under ``SHARED_STORAGE``, which ordinary users can write to, so a user could point a server type's binary path at a file placed there and have pgAdmin execute it (CVE-2026-116243). Every ``SHARED_STORAGE`` entry is now rejected alongside ``STORAGE_DIR``, after expanding ``$DIR`` and ``..`` and resolving symbolic links, so an existing binary path under a shared storage directory stops working. An empty ``STORAGE_DIR`` is not covered. Reported by Harsh Singh.
| `Issue #10662 <https://github.com/pgadmin-org/pgadmin4/issues/10662>`_ - Stop SSH tunnels using the pgAdmin service account's own SSH identity, where sshtunnel always loaded the unencrypted private keys in the service account's ``~/.ssh``, read its ``~/.ssh/config`` and could use its ssh-agent, so any user could configure a tunnel that authenticated with the service account's key (CVE-2026-116242). In server mode the tunnel no longer reads those keys or that configuration, or uses the agent, and an identity file that cannot be found in the user's storage is reported. Tunnels relying on the service account's key, config or agent must have an identity file in the user's storage or a password configured on the server.
| `Issue #10663 <https://github.com/pgadmin-org/pgadmin4/issues/10663>`_ - Fix OS command injection in the Import/Export Data tool, where a query-based export could pass a crafted query past the ``\copy (...)`` parenthesis-balance guard through a backslash inside a double-quoted identifier, which psql treats as an escape when ``standard_conforming_strings`` is off, exposing a live ``TO PROGRAM`` clause that runs an arbitrary command on the pgAdmin host, an incomplete fix for CVE-2026-17566 (CVE-2026-116241). A backslash inside a double-quoted identifier is now rejected, and so is a backslash or null byte in the schema, table or column names of an export or import, which reached the same ``\copy`` command through ``qtIdent()``. Reported by Yonghwa Lee (Xint by Theori).
| `Issue #10674 <https://github.com/pgadmin-org/pgadmin4/issues/10674>`_ - Fix the File Manager and the storage-path tools acting on a different path from the one that was checked (CVE-2026-116240): opening, saving and listing files, download, delete, rename, create-folder and upload could name files outside the user's storage directory, or in another user's directory whose name begins with the same characters. Every File Manager and storage-path caller now acts on the absolute path that was checked, and in server mode on POSIX files are opened relative to the storage directory without following symbolic links, so symbolic links to directories and hard-linked files inside it can no longer be opened, downloaded or renamed through. The storage directory itself can no longer be deleted.
| `Issue #10675 <https://github.com/pgadmin-org/pgadmin4/issues/10675>`_ - Fix LDAP and Kerberos authentication logging a user in to a different account that shared their username: Kerberos and LDAP looked the account up by username alone, or accepted the account Flask-Security's internal validation had matched by the email typed, so a Kerberos or LDAP user could be logged in as an Internal account, including the initial administrator, or as another user (CVE-2026-116239). Accounts are now looked up by the authenticated username and the source that authenticated them, and only internal authentication logs in an account from its own form. Webserver users whose username matches an Internal account, and LDAP users with capitals in their username, now log in correctly, and ``setup.py`` can update a user without a role and add one without ``--role``. Users who relied on being logged in to an Internal account of the same name now need an account of their own source. Reported by Yves Soete of Blacksight LLC (@yssoe).
| `Issue #10676 <https://github.com/pgadmin-org/pgadmin4/issues/10676>`_ - Fix bypasses of the failed-login limit and of pgAdmin's own login, password change and password reset checks, where a username in another case or a wrong internal password with LDAP or Webserver authentication also configured was never counted, and where Flask-Security's own ``/login``, ``/verify``, ``/change``, ``/reset`` and ``/reset/<token>`` views accepted submissions that skipped the failed-login count and lock, the change password permission, the re-encryption of saved passwords, and the internal-account check on resets (CVE-2026-116238). Every failed internal login is now counted (when ``MAX_LOGIN_ATTEMPTS`` is set) and only internal authentication is locked, so a locked Internal account no longer blocks other sources. A login form that posts a password is no longer passed to Kerberos, OAuth2 or Webserver authentication, submissions to Flask-Security's views are refused with 405, and password resets act only on the internal account.
+20
View File
@@ -77,6 +77,10 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
* Move the switch next to *Only schema* to limit the restoration to
schema-level database objects.
* Move the switch next to *Only statistics* to the *Yes* position to limit
the restoration to optimizer statistics. **Note:** This option is visible
only for database server greater than or equal to 18.
.. image:: images/restore_do_not_save.png
:alt: Restore dialog do not save section
:align: center
@@ -110,6 +114,22 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
Table access methods. **Note:** This option is visible only for
database server greater than or equal to 15.
* Move the switch next to *Row security policies* to the *Yes* position to
exclude row security policies. **Note:** This option is visible only for
database server greater than or equal to 18.
* Move the switch next to *Data* to the *Yes* position to exclude data from
the restore. **Note:** This option is visible only for database server
greater than or equal to 18.
* Move the switch next to *Schema* to the *Yes* position to exclude schema
(the data definitions) from the restore. **Note:** This option is visible
only for database server greater than or equal to 18.
* Move the switch next to *Statistics* to the *Yes* position to exclude
optimizer statistics from the restore. **Note:** This option is visible
only for database server greater than or equal to 18.
.. image:: images/restore_queries.png
:alt: Restore dialog queries section
:align: center
+224 -13
View File
@@ -195,7 +195,7 @@ the Python Wheel (you may need to adjust the path to suit your installation):
gunicorn --bind 0.0.0.0:80 \
--workers=1 \
--threads=25 \
--chdir /usr/lib/python3.7/dist-packages/pgadmin4 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4 \
pgAdmin4:app
Standalone uWSGI Configuration
@@ -210,9 +210,48 @@ the Python Wheel (you may need to adjust the path to suit your installation):
uwsgi --http-socket 0.0.0.0:80 \
--processes 1 \
--threads 25 \
--chdir /usr/lib/python3.7/dist-packages/pgadmin4/ \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4/ \
--mount /=pgAdmin4:app
.. _sub_directory_hosting:
Hosting in a Sub-Directory
--------------------------
Any of the reverse proxy configurations described below can host pgAdmin in a
sub-directory of the server (``/pgadmin4`` in each of the examples) rather than
at its root, but doing so requires that the ``SCRIPT_NAME`` environment
variable is set for the Gunicorn or uWSGI process, whichever is in use.
pgAdmin reads ``SCRIPT_NAME`` from the process environment once, at startup,
and uses it to set ``APPLICATION_ROOT`` and ``SESSION_COOKIE_PATH``, so that
URLs, redirects (including the one issued after a successful login) and
session cookies are all generated relative to the sub-directory rather than to
the root of the server. Without it, a successful login redirects to the root of
the server, which typically presents to the user as a redirect loop.
This is a separate mechanism from the per-request ``X-Script-Name`` header that
the NGINX Gunicorn example below sets, and neither substitutes for the other.
It is also separate from uWSGI's ``--manage-script-name``, which only affects
the per-request WSGI environment that uWSGI builds; the uWSGI examples below
set ``SCRIPT_NAME`` alongside it so that both mechanisms agree, and so that the
session cookie is confined to the sub-directory rather than being issued for
the root of the server.
.. _proxy_headers:
Reverse Proxy Headers
---------------------
pgAdmin honours the ``X-Script-Name`` and ``X-Scheme`` request headers
unconditionally, unlike the ``X-Forwarded-*`` headers, which are trusted only
to the depth configured by the ``PROXY_X_*_COUNT`` settings. A client that
supplied its own ``X-Script-Name`` could therefore change every URL pgAdmin
generates, so the reverse proxy must always either overwrite both headers with
values of its own or remove them outright, rather than passing on whatever the
client sent. Each of the examples below does one or the other, and a proxy
configuration not derived from them should do the same.
NGINX Configuration with Gunicorn
---------------------------------
@@ -228,7 +267,7 @@ command similar to:
gunicorn --bind unix:/tmp/pgadmin4.sock \
--workers=1 \
--threads=25 \
--chdir /usr/lib/python3.7/dist-packages/pgadmin4 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4 \
pgAdmin4:app
And configure NGINX:
@@ -238,11 +277,24 @@ And configure NGINX:
location / {
include proxy_params;
proxy_pass http://unix:/tmp/pgadmin4.sock;
proxy_set_header X-Script-Name "";
proxy_set_header X-Scheme "";
}
Alternatively, pgAdmin can be hosted in a sub-directory (/pgadmin4 in this case)
on the server. Start Gunicorn as when using the root directory, but configure
NGINX as follows:
on the server. Start Gunicorn as when using the root directory, but also set the
``SCRIPT_NAME`` environment variable for the Gunicorn process, as described in
:ref:`sub_directory_hosting`:
.. code-block:: bash
SCRIPT_NAME=/pgadmin4 gunicorn --bind unix:/tmp/pgadmin4.sock \
--workers=1 \
--threads=25 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4 \
pgAdmin4:app
Then configure NGINX:
.. code-block:: nginx
@@ -250,6 +302,7 @@ NGINX as follows:
include proxy_params;
proxy_pass http://unix:/tmp/pgadmin4.sock;
proxy_set_header X-Script-Name /pgadmin4;
proxy_set_header X-Scheme "";
}
NGINX Configuration with uWSGI
@@ -267,7 +320,7 @@ command similar to:
uwsgi --socket /tmp/pgadmin4.sock \
--processes 1 \
--threads 25 \
--chdir /usr/lib/python3.7/dist-packages/pgadmin4/ \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4/ \
--manage-script-name \
--mount /=pgAdmin4:app
@@ -279,20 +332,23 @@ And configure NGINX:
location @pgadmin4 {
include uwsgi_params;
uwsgi_pass unix:/tmp/pgadmin4.sock;
uwsgi_param HTTP_X_SCRIPT_NAME "";
uwsgi_param HTTP_X_SCHEME "";
}
Alternatively, pgAdmin can be hosted in a sub-directory (/pgadmin4 in this case)
on the server. Start uWSGI, noting that the directory name is specified in the
``mount`` parameter:
``mount`` parameter, and that the ``SCRIPT_NAME`` environment variable should
be set alongside it, as described in :ref:`sub_directory_hosting`:
.. code-block:: bash
uwsgi --socket /tmp/pgadmin4.sock \
--processes 1 \
--threads 25 \
--chdir /usr/lib/python3.7/dist-packages/pgadmin4/ \
--manage-script-name \
--mount /pgadmin4=pgAdmin4:app
SCRIPT_NAME=/pgadmin4 uwsgi --socket /tmp/pgadmin4.sock \
--processes 1 \
--threads 25 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4/ \
--manage-script-name \
--mount /pgadmin4=pgAdmin4:app
Then, configure NGINX:
@@ -303,6 +359,161 @@ Then, configure NGINX:
location @pgadmin4 {
include uwsgi_params;
uwsgi_pass unix:/tmp/pgadmin4.sock;
uwsgi_param HTTP_X_SCRIPT_NAME "";
uwsgi_param HTTP_X_SCHEME "";
}
Caddy Configuration with Gunicorn
----------------------------------
pgAdmin can be hosted by Gunicorn, with Caddy in front of it as a reverse
proxy. Note that these examples assume pgAdmin was installed using the Python
Wheel (you may need to adjust the path to suit your installation).
To run with pgAdmin in the root directory of the server, start Gunicorn using
a command similar to:
.. code-block:: bash
gunicorn --bind unix:/run/pgadmin4/pgadmin4.sock \
--workers=1 \
--threads=25 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4 \
pgAdmin4:app
And configure Caddy:
.. code-block:: text
pgadmin.example.com {
reverse_proxy unix//run/pgadmin4/pgadmin4.sock {
header_up -X-Script-Name
header_up -X-Scheme
}
}
.. _caddy_socket_location:
.. note:: The examples deliberately avoid ``/tmp`` for the socket. The systemd
unit shipped with Caddy sets ``PrivateTmp=true``, which gives the Caddy
process a private ``/tmp`` directory of its own, so a socket created by
Gunicorn or uWSGI in the system ``/tmp`` is invisible to Caddy, which will
report a 502 error for every request. Any directory outside ``/tmp`` that
both processes can access will do, provided the user Caddy runs as has
permission to read and write the socket; alternatively, have Gunicorn or
uWSGI listen on a TCP port such as ``127.0.0.1:5050`` and proxy to that
instead. Whichever directory is used, it must exist and be writable by the
user Gunicorn or uWSGI runs as before the socket can be bound; under
systemd, ``RuntimeDirectory=pgadmin4`` in the unit that starts Gunicorn or
uWSGI will create ``/run/pgadmin4`` on start and remove it on stop. The
same applies to the uWSGI examples below.
.. _caddy_header_stripping:
.. note:: The two ``header_up`` directives remove any ``X-Script-Name`` and
``X-Scheme`` headers that arrive from the client, for the reasons given in
:ref:`proxy_headers`. Each of the Caddy examples removes both, except that
the Gunicorn sub-directory example sets ``X-Script-Name`` to the
sub-directory instead, which likewise replaces whatever the client sent.
Alternatively, pgAdmin can be hosted in a sub-directory (/pgadmin4 in this
case) on the server. Start Gunicorn as when using the root directory, but
also set the ``SCRIPT_NAME`` environment variable for the Gunicorn process, as
described in :ref:`sub_directory_hosting`:
.. code-block:: bash
SCRIPT_NAME=/pgadmin4 gunicorn --bind unix:/run/pgadmin4/pgadmin4.sock \
--workers=1 \
--threads=25 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4 \
pgAdmin4:app
Then configure Caddy. The request path must be passed through to Gunicorn
unchanged, so do not strip the /pgadmin4 prefix; the ``X-Script-Name`` header
is set to the sub-directory, both to tell pgAdmin which requests are made
under it and to replace any value the client may have sent; and the path
matcher must include both ``/pgadmin4`` and ``/pgadmin4/*``, so that pgAdmin's
own redirect to the bare sub-directory path (with no trailing slash) is also
proxied, rather than falling through to Caddy's default (and rather unhelpful)
empty response for an unmatched path:
.. code-block:: text
pgadmin.example.com {
@pgadmin path /pgadmin4 /pgadmin4/*
handle @pgadmin {
reverse_proxy unix//run/pgadmin4/pgadmin4.sock {
header_up X-Script-Name /pgadmin4
header_up -X-Scheme
}
}
}
Caddy Configuration with uWSGI
-------------------------------
Caddy does not speak the native uwsgi protocol used by NGINX's
``uwsgi_pass``, so uWSGI must be run in HTTP mode instead, using
``--http-socket`` rather than ``--socket``. Note that these examples assume
pgAdmin was installed using the Python Wheel (you may need to adjust the
path to suit your installation).
To run with pgAdmin in the root directory of the server, start uWSGI using a
command similar to:
.. code-block:: bash
uwsgi --http-socket /run/pgadmin4/pgadmin4.sock \
--processes 1 \
--threads 25 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4/ \
--mount /=pgAdmin4:app
And configure Caddy, again keeping the socket out of ``/tmp`` (see
:ref:`the note above <caddy_socket_location>`) and stripping the headers
pgAdmin trusts unconditionally (see :ref:`the note above
<caddy_header_stripping>`):
.. code-block:: text
pgadmin.example.com {
reverse_proxy unix//run/pgadmin4/pgadmin4.sock {
header_up -X-Script-Name
header_up -X-Scheme
}
}
Alternatively, pgAdmin can be hosted in a sub-directory (/pgadmin4 in this
case) on the server. Start uWSGI, noting that the directory name is specified
in the ``mount`` parameter, and that the ``SCRIPT_NAME`` environment variable
should still be set alongside it, as described in
:ref:`sub_directory_hosting`:
.. code-block:: bash
SCRIPT_NAME=/pgadmin4 uwsgi --http-socket /run/pgadmin4/pgadmin4.sock \
--processes 1 \
--threads 25 \
--chdir /usr/lib/python3.13/dist-packages/pgadmin4/ \
--manage-script-name \
--mount /pgadmin4=pgAdmin4:app
Then configure Caddy as for the Gunicorn sub-directory example above, except
that no ``X-Script-Name`` header needs to be set: ``--manage-script-name`` has
uWSGI report the mount point to pgAdmin with every request, as in the NGINX
uWSGI example above, so the header is only removed:
.. code-block:: text
pgadmin.example.com {
@pgadmin path /pgadmin4 /pgadmin4/*
handle @pgadmin {
reverse_proxy unix//run/pgadmin4/pgadmin4.sock {
header_up -X-Script-Name
header_up -X-Scheme
}
}
}
Additional Information
+113 -3
View File
@@ -33,6 +33,18 @@ Use the fields in the *General* tab to identify the server:
* If the *Shared?* switch is moved to *Yes* then that server can be
shared with all the other users. This option is available only to admin users.
For more information on users see :ref:`User Management Dialog <user_management>`.
Sharing a server, whether in this dialog, through the API or by importing a
servers.json file, is restricted to users with the *Administrator* role.
Servers that were shared by non-administrator users before this restriction
was introduced remain shared until they are un-shared, so administrators
should audit them: look for servers with the shared flag set in the
configuration database whose owner does not have the *Administrator* role.
pgAdmin logs a warning for each such server when it starts in server mode.
Such a server can be un-shared by its owner through the server API (a PUT
request on the server with ``"shared": false``), or by an administrator
changing the ``shared`` column of the server record in the pgAdmin
configuration database. The *Shared?* switch in this dialog is shown only
to administrators, and only the owner of a server can change it.
Users can access the shared servers with some restrictions - the following
operations on shared servers are not permitted:
@@ -41,6 +53,17 @@ Use the fields in the *General* tab to identify the server:
* Rename the group server
* Change of host, port, and maintenance database
Each user of a shared server has their own copy of some of its settings.
Tags, colours, the role and the service name are copied from the owner
the first time a user opens the server, and each user can then change
their copy. The host, port, maintenance database and the general
connection parameters (such as *connect_timeout* or *sslmode*) always
come from the owner's server definition, so a change the owner makes
to them is seen by every user. The owner's password, SSH tunnel
credentials, SSL certificate, key and CRL paths, and password file
(*passfile*) are never shared: each user must supply their own in the
server dialog if they need them.
Please note that once the server is shared, it's icon is changed in the
object explorer.
@@ -85,6 +108,17 @@ Use the fields in the *Connection* tab to configure a connection:
see
`Section 33.16 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgservice.html>`_.
In server mode, services are read from the connection service file of the
account that pgAdmin runs as, so a server can use only a service that the
administrator has listed in the ``SERVER_MODE_ALLOWED_SERVICES`` setting
(see :ref:`config_py`), which is empty by default. A server that uses any
other service cannot be saved, and an existing one fails to connect with an
error naming the setting. Listing a service shares its credentials, such as
a password in its entry, with every pgAdmin user. The ``servicefile``
connection parameter cannot be used in server mode, and pgAdmin ignores any
``PGPASSWORD`` or ``PGSERVICE`` environment variable set for the account it
runs as.
Click the *Parameters* tab to continue.
.. image:: images/server_parameters.png
@@ -107,6 +141,10 @@ Click on the *+* button to add a new parameter. Some of the parameters are:
in seconds. Zero or not specified means wait indefinitely. It is not
recommended to use a timeout of less than 2 seconds. By default it is set to
10 seconds.
* *Require authentication* (*require_auth*) field to specify the
authentication methods the server may use. In server mode, pgAdmin
refuses the GSSAPI and SSPI methods for a connection that may not use
Kerberos, as described in :ref:`kerberos`.
* *SSL mode* field to select the type of SSL connection the server should use.
For more information about using SSL encryption, see
`Section 33.18 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-ssl.html>`_.
@@ -145,6 +183,20 @@ icon that is located to the right of each of the following fields.
means that administrators of the server may be able to access those files;
appropriate caution should be taken before choosing to use this feature.
.. note:: In Server mode, every connection file path (the *Password file*,
client certificate and key, root certificate, certificate revocation list,
CRL directory and SSL key log file) must resolve inside your storage
directory, or inside a *SHARED_STORAGE* entry (see :ref:`config_py`)
written as *Name:/path*. A path that leaves it through *..* or a symbolic
link is refused with an "Access denied (...): the path resolves outside
your storage directory..." message when connecting or starting a utility.
If you used a symbolic link in your storage directory to reach, for
example, */etc/pgadmin/certs*, configure that directory as a
*SHARED_STORAGE* entry instead (see :ref:`storage_manager`). Every pgAdmin
user can use a file in shared storage, so it should hold only shareable
files such as a root certificate or CRL, never a private key or a
*.pgpass* file.
Click the *SSH Tunnel* tab to continue.
.. image:: images/server_ssh_tunnel.png
@@ -175,6 +227,9 @@ not be able to connect directly.
* If the SSH host is expecting a private key file for authentication, use the
*Identity file* field to specify the location of the key file.
In server mode, pgAdmin does not use the private keys, ssh-agent or
``~/.ssh/config`` of the account pgAdmin runs as; the identity file must be
located inside your storage directory.
* If the SSH host is expecting a password of the user name or an identity file
if being used, use the *Password* field to specify the password.
* Check the box next to *Prompt for password?* to to have pgAdmin prompt for
@@ -211,7 +266,7 @@ Use the fields in the *Advanced* tab to configure a connection:
that will be used against the pg_database table to limit the databases that you see.
For example, you might enter: *live_db test_db* so that only live_db and test_db
are shown in the pgAdmin object explorer.
* Use the *Password exec command* field to specify a shell command to be executed
* In desktop mode, use the *Password exec command* field to specify a shell command to be executed
to retrieve a password to be used for SQL authentication. The ``stdout`` of the
command will be used as the SQL password. This may be useful when the password
should be generated as a transient authorization token instead of providing a
@@ -219,8 +274,36 @@ Use the fields in the *Advanced* tab to configure a connection:
You can pass server hostname, port and DB username to the password exec command as variable by providing placeholders
like ``%HOSTNAME%``, ``%PORT%`` and ``%USERNAME%`` which will be replace with the server connection information.
Example: ``/path/to/script --hostname %HOSTNAME% --port %PORT% --username %USERNAME%``
* In server mode, use the *Password exec command* drop-down list to select one
of the commands that the administrator has defined in the
``SERVER_PASSEXEC_COMMANDS`` setting (see :ref:`config_py`). Users cannot
enter their own command. The list offers *None* and each configured command
name, and is hidden if no commands have been configured. On a shared server,
users who do not own the server also see *Inherit from owner*, which is the
default for them and uses whatever command the owner has selected; selecting
*None* or a named command overrides it for that user only. If a selected
command is later removed from the configuration, the server is treated as
having no command and a warning is logged.
The command is run directly, without a shell, and does not receive the full
environment of the pgAdmin process. Only ``PATH``, ``HOME``, ``LANG``,
``LANGUAGE``, ``TZ``, ``TMPDIR``, ``TMP``, ``TEMP``, ``USER``, ``LOGNAME``
and any ``LC_*`` variable are passed through (and, on Windows,
``SYSTEMROOT``, ``SYSTEMDRIVE``, ``PATHEXT``, ``COMSPEC`` and ``WINDIR``),
together with any variables the administrator has named in the
``SERVER_PASSEXEC_ENV_PASSTHROUGH`` setting. The command also receives the
following variables describing the connection, which take precedence over
any variable of the same name:
``PGADMIN_PASSEXEC_HOST``, ``PGADMIN_PASSEXEC_PORT``,
``PGADMIN_PASSEXEC_USERNAME`` (the username that connection uses, so a
non-owner's own username on a shared server), ``PGADMIN_PASSEXEC_DATABASE``
(the maintenance database), ``PGADMIN_PASSEXEC_PGADMIN_USER`` (the pgAdmin
user making the connection) and ``PGADMIN_PASSEXEC_AUTH_SOURCE`` (how that
user authenticated to pgAdmin). The ``stdout`` of the command is used as the
SQL password.
* Use the *Password exec expiration* field to specify a maximum age, in seconds,
of the password generated with a *Password exec command*. If not specified,
of the password generated with a *Password exec command*. In server mode, this field is
enabled only when a named command is selected. If not specified,
the password will not expire until your pgAdmin session does.
Zero means the command will be executed for each new connection or reconnection that is made.
If the generated password is not valid indefinitely, set this value to slightly before it will expire.
@@ -234,7 +317,34 @@ Use the fields in the *Advanced* tab to configure a connection:
.. note:: The password file option is only supported when pgAdmin is using libpq
v10.0 or later to connect to the server.
.. note:: The Password exec option is only supported when pgAdmin is run in desktop mode.
.. note:: In server mode, the *Password exec command* setting is available
only when the administrator has defined at least one command in
``SERVER_PASSEXEC_COMMANDS``. Free-text commands are never run in server
mode, and when pgAdmin is upgraded, an existing free-text command is kept
only if it exactly matches a configured command (its arguments joined by
single spaces), in which case it is converted to that command's name; all
others are cleared and a warning is logged. This conversion cannot be
undone, so ``SERVER_PASSEXEC_COMMANDS`` must be configured before the
first start after upgrading. If it is still empty at that point, the
conversion is postponed: existing commands are left in the configuration
database unused, a warning giving the number of affected servers is
logged at each start, and they are converted or cleared on the first
start at which at least one command is configured. Placeholders such as
``%HOSTNAME%``, ``%PORT%`` and ``%USERNAME%`` are not substituted in
server mode, so a command containing them is converted only if the
configured arguments contain the same literal text. On a shared server, a
user who does not own the server and whose own command is cleared will
then inherit the owner's command, if the owner has one. The
``ENABLE_SERVER_PASS_EXEC_CMD`` setting is deprecated and ignored.
.. warning:: In server mode, only ``PGADMIN_PASSEXEC_PGADMIN_USER`` and
``PGADMIN_PASSEXEC_AUTH_SOURCE`` identify the pgAdmin user on whose behalf
the command is run. ``PGADMIN_PASSEXEC_HOST``, ``PGADMIN_PASSEXEC_PORT``,
``PGADMIN_PASSEXEC_USERNAME`` and ``PGADMIN_PASSEXEC_DATABASE`` are set by
whoever edits the server definition; on a shared server, a user who does
not own the server sets their own username. Commands should therefore
decide whether to issue a password based on the pgAdmin identity, and
treat the other four variables as untrusted input.
Click the *Post Connection SQL* tab to continue.
+93
View File
@@ -0,0 +1,93 @@
.. _statistics_dialog:
**************************
`Statistics Dialog`:index:
**************************
Use the *Statistics* dialog to define extended statistics on one or more columns
(or expressions) of a table. Extended statistics let PostgreSQL collect
correlation data across columns that can significantly improve query-plan
estimates for queries that filter or group by multiple columns.
PostgreSQL introduced ``CREATE STATISTICS`` in PostgreSQL 10, and added
expression statistics in PostgreSQL 14. This dialog is available for
PostgreSQL 14 and later, which covers all currently supported PostgreSQL
versions.
The *Statistics* dialog organizes options across the *General* and *Definition*
tabs. The *SQL* tab displays the SQL command generated by your selections.
.. image:: images/statistics_general.png
:alt: Statistics dialog general tab
:align: center
Use the fields in the *General* tab to describe the statistics object:
* Use the *Name* field to enter a descriptive name. On PostgreSQL 16 and later
the name is optional, and the server will generate one from the table and the
columns or expressions if you leave it blank.
* Use the *Owner* field to select the role that will own the statistics object.
* Use the *Schema* field to select the schema in which the statistics object
will reside.
* Use the *Table* field to select the table on which the statistics will be
collected. The list is filtered to tables in the selected schema.
* Use the *Columns* field to select two or more columns. Hold *Ctrl* (or *Cmd*
on macOS) to select multiple columns. At least two columns are required when
collecting column based statistics, although a single column is enough when
it is combined with an expression.
* Use the *Statistics types* field to choose which kinds of extended statistics
to collect:
* *N-distinct*, which estimates the number of distinct value combinations
across the selected columns or expressions.
* *Dependencies*, which detects functional dependencies between columns,
improving estimates for queries with correlated ``WHERE`` clauses.
* *MCV (Most Common Values)*, which records the most common combinations of
values.
If you leave the field empty, PostgreSQL collects every kind it supports.
Leave it empty for statistics on a single expression, which do not accept
a choice of kinds.
* Use the *Comment* field to store an optional note about the statistics object.
Click the *Definition* tab to continue.
.. image:: images/statistics_definition.png
:alt: Statistics dialog definition tab
:align: center
* Use the *Expressions* field to enter one or more SQL expressions separated by
commas (for example ``lower(col1), (col1 + col2)``). Each expression must be
enclosed in parentheses unless it is a function call, and the list is passed
to the server exactly as you enter it, so an expression may itself contain
commas. Expressions may be given instead of columns, or alongside them when
you want statistics over a mixture of the two.
When you open the dialog on an existing statistics object, the *Properties*
view also reports the statistics target and, for roles with access, the values
that ``ANALYZE`` has collected. Those values are read through the
``pg_catalog.pg_stats_ext`` view, which only shows them to roles the server
allows to see them (the table's owners, on current PostgreSQL releases), so
the *Computed Statistics* group is hidden when the current role lacks access.
Click the *SQL* tab to continue.
Your entries in the *Statistics* dialog generate a SQL command (see an example
below). Use the *SQL* tab for review; revisit or switch tabs to make any changes.
Example
*******
The following is an example of the SQL command generated by user selections in
the *Statistics* dialog:
.. image:: images/statistics_sql.png
:alt: Statistics dialog SQL tab
:align: center
* Click the *Info* button (i) to access online help.
* Click the *Save* button to save work.
* Click the *Close* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters.
+75 -21
View File
@@ -60,7 +60,7 @@ Provide information about the new pgAdmin role in the row:
specified in the *Email* field. This field is disabled if you select any
authentication source except *internal*.
* Re-enter the password in the *Confirm password* field. This field is disabled
if you select *ldap* as authentication source.
if you select any authentication source except *internal*.
* *Locked* switch cannot be changed if is turned off. It can only be changed
when the user is locked by trying unsuccessful login attempts. Turn off the
switch if you want to unlock the account.
@@ -132,6 +132,56 @@ a role.
.. _auth_source_accounts:
Accounts from different authentication sources
##############################################
pgAdmin treats accounts from different authentication sources as separate
accounts, even when they share a username or an email address. Each has its
own role, settings and servers:
* A user authenticated by LDAP, Kerberos, OAuth2 or webserver authentication
is only ever logged in to the account with their username *and* that
authentication source, never to an account from another source with the
same username. If there is no such account, and the source does not create
one automatically, the login fails; pgAdmin does not log the user in to an
account from another source instead.
* An internal login is checked against, and logs in, only the ``INTERNAL``
account.
* Only an ``INTERNAL`` account has a password, so *Forgotten your password?*
resets only the ``INTERNAL`` account with the email address given.
The account-lockout setting *MAX_LOGIN_ATTEMPTS* applies only to ``INTERNAL``
accounts. pgAdmin never locks an account from another authentication source;
brute-force protection for those is the responsibility of the directory,
identity provider or reverse proxy. When ``INTERNAL`` and another source are
both enabled, a sign-in that fails overall and was tried against an
``INTERNAL`` account with that username counts towards its lockout; the attempt
that reaches the limit reports that the account is now locked. A locked
``INTERNAL`` account stops only internal sign-in: a user of another source with
the same username can still sign in. On a later sign-in with that username,
pgAdmin discloses that the ``INTERNAL`` account is locked only when internal is
the only source able to check the password; while another password source such
as LDAP is also eligible, it shows a generic failure instead.
The administrator account created when pgAdmin is first set up always uses the
``INTERNAL`` authentication source. It remains in the pgAdmin database when
*AUTHENTICATION_SOURCES* does not include *internal*, although it can then no
longer be used to log in. If you use external authentication only, create an
administrator account for that source, for example for LDAP:
.. code-block:: bash
/path/to/python /path/to/setup.py add-external-user ldapuser --auth-source ldap --admin
and then deactivate the initial ``INTERNAL`` administrator account, so that it
cannot be used if internal authentication is enabled again later:
.. code-block:: bash
/path/to/python /path/to/setup.py update-user admin@example.com --inactive
Using 'setup.py' command line script
####################################
@@ -146,7 +196,7 @@ Using 'setup.py' command line script
without Python interpreter.
Some of the examples:
pgadmin4-cli add-user user1@gmail.com password --role 1
pgadmin4-cli add-user user1@gmail.com password --role User
pgadmin4-cli get-prefs
Manage Users
@@ -156,7 +206,8 @@ Add User
*********
To add user, invoke ``setup.py`` with ``add-user`` command line option, followed by
email and password. role and active will be optional fields.
email and password. role and active will be optional fields. When no role is
given, the user is created with the *User* role.
.. code-block:: bash
@@ -166,7 +217,7 @@ email and password. role and active will be optional fields.
# role using --role. If both are provided --admin will be used:
/path/to/python /path/to/setup.py add-user user1@gmail.com password --admin
/path/to/python /path/to/setup.py add-user user1@gmail.com password --role Users
/path/to/python /path/to/setup.py add-user user1@gmail.com password --role User
# to specify user's status
@@ -177,26 +228,28 @@ Add External User
*****************
To add external authentication user, invoke ``setup.py`` with ``add-external-user`` command line option,
followed by email, password and authentication source. email, role and status will be optional fields.
followed by username, and the authentication source with ``--auth-source`` (*oauth2* if it is not
given). email, role and status will be optional fields. When no role is given,
the user is created with the *User* role.
.. code-block:: bash
/path/to/python /path/to/setup.py add-external-user user1@gmail.com ldap
/path/to/python /path/to/setup.py add-external-user user1@gmail.com --auth-source ldap
# to specify an email:
/path/to/python /path/to/setup.py add-external-user ldapuser ldap --email user1@gmail.com
/path/to/python /path/to/setup.py add-external-user ldapuser --auth-source ldap --email user1@gmail.com
# to specify a role, either you can use --admin for Administrator role or provide the
# role using --role. If both are provided --admin will be used:
/path/to/python /path/to/setup.py add-external-user ldapuser ldap --admin
/path/to/python /path/to/setup.py add-external-user ldapuser ldap --role Users
/path/to/python /path/to/setup.py add-external-user ldapuser --auth-source ldap --admin
/path/to/python /path/to/setup.py add-external-user ldapuser --auth-source ldap --role User
# to specify user's status
/path/to/python /path/to/setup.py add-external-user user1@gmail.com ldap --active
/path/to/python /path/to/setup.py add-external-user user1@gmail.com ldap --inactive
/path/to/python /path/to/setup.py add-external-user user1@gmail.com --auth-source ldap --active
/path/to/python /path/to/setup.py add-external-user user1@gmail.com --auth-source ldap --inactive
Update User
***********
@@ -211,19 +264,20 @@ email address. password, role and active are updatable fields.
# to specify a role, either you can use --admin for Administrator role or provide the
# role using --role. If both are provided --admin will be used:
/path/to/python /path/to/setup.py update-user user1@gmail.com password --admin
/path/to/python /path/to/setup.py update-user user1@gmail.com password --role Users
/path/to/python /path/to/setup.py update-user user1@gmail.com --admin
/path/to/python /path/to/setup.py update-user user1@gmail.com --role User
# to specify user's status
/path/to/python /path/to/setup.py update-user user1@gmail.com password --active
/path/to/python /path/to/setup.py update-user user1@gmail.com password --inactive
/path/to/python /path/to/setup.py update-user user1@gmail.com --active
/path/to/python /path/to/setup.py update-user user1@gmail.com --inactive
Update External User
********************
To update the external user, invoke ``setup.py`` with ``update-external-user`` command line option,
followed by username and auth source. email, password, role and active are updatable fields.
followed by username, and the authentication source with ``--auth-source`` (*oauth2* if it is not
given). email, role and active are updatable fields.
.. code-block:: bash
@@ -234,19 +288,19 @@ followed by username and auth source. email, password, role and active are updat
# to specify a role, either you can use --admin for Administrator role or provide the
# role using --role. If both are provided --admin will be used:
/path/to/python /path/to/setup.py update-external-user user1@gmail.com password --role --admin
/path/to/python /path/to/setup.py update-external-user user1@gmail.com password --role --role Users
/path/to/python /path/to/setup.py update-external-user ldapuser --auth-source ldap --admin
/path/to/python /path/to/setup.py update-external-user ldapuser --auth-source ldap --role User
# to change user's status
/path/to/python /path/to/setup.py update-user ldapuser --auth-source ldap --active
/path/to/python /path/to/setup.py update-user ldapuser --auth-source ldap --inactive
/path/to/python /path/to/setup.py update-external-user ldapuser --auth-source ldap --active
/path/to/python /path/to/setup.py update-external-user ldapuser --auth-source ldap --inactive
Delete User
***********
To delete the user, invoke ``setup.py`` with ``delete-user`` command line option, followed by
username and auth_source. For Internal users, email adress will be used instead of username. the option ``--yes`` is available to skip the confirmation prompt before deleting the user.
username and auth_source. For Internal users, email address will be used instead of username. the option ``--yes`` is available to skip the confirmation prompt before deleting the user.
.. code-block:: bash
+54 -2
View File
@@ -20,7 +20,7 @@ and modify the values for the following parameters:
:widths: 35, 55
"AUTHENTICATION_SOURCES", "The default value for this parameter is *internal*.
To enable OAUTH2 authentication, you must include *webserver* in the list of values
To enable Webserver authentication, you must include *webserver* in the list of values
for this parameter. you can modify the value as follows:
* [‘webserver’]: pgAdmin will use only Webserver authentication.
@@ -36,8 +36,60 @@ and modify the values for the following parameters:
environment variable name which comes from the web server after webserver authentication.
The default value is REMOTE_USER and the possible values are REMOTE_USER,
HTTP_X_FORWARDED_USER, X-Forwarded-User."
"WEBSERVER_REMOTE_USER_FROM_HEADER", "Set to *True* only if your reverse proxy passes the
authenticated identity as an HTTP request header rather than the REMOTE_USER CGI variable.
Defaults to *False*. See the warning below before enabling this."
"WEBSERVER_TRUSTED_PROXIES", "A list of IP addresses/CIDR ranges of the reverse proxies
that are allowed to assert the identity header. Required (non-empty) for
WEBSERVER_REMOTE_USER_FROM_HEADER to take effect. Defaults to an empty list."
"WEBSERVER_SHARED_SECRET", "An optional shared secret that the trusted proxy must inject
into every request, as additional proof that the identity header was set by the proxy
and not the client. Defaults to *None* (not checked)."
"WEBSERVER_SHARED_SECRET_HEADER", "The header name carrying WEBSERVER_SHARED_SECRET.
Defaults to *X-Pgadmin-Webserver-Secret*."
.. note:: If REMOTE_USER does not work, try replacing it with either REMOTE-USER or Remote-user.
.. warning::
Setting WEBSERVER_REMOTE_USER to a header-derived name (such as
HTTP_X_FORWARDED_USER, or REMOTE-USER/Remote-user) means the identity is
read from a client-controlled HTTP request header, not necessarily a
value set by your webserver's authentication plug-in. Any client that
can reach pgAdmin can set this header itself and impersonate any user,
including an existing Administrator, unless you:
* Set ``WEBSERVER_REMOTE_USER_FROM_HEADER = True``.
* List every reverse proxy allowed to assert the identity in
``WEBSERVER_TRUSTED_PROXIES``.
* Configure your reverse proxy to strip *every* inbound spelling of the
header (any hyphen/underscore variant, in any case) before it sets its
own, so a client cannot smuggle a value past it.
* Optionally configure ``WEBSERVER_SHARED_SECRET`` /
``WEBSERVER_SHARED_SECRET_HEADER`` as an additional proof that the
header was set by your proxy.
Without all of the above, pgAdmin does not trust a header-asserted
identity and login through it is rejected.
.. warning::
A user matched via Webserver authentication is only logged in if their
*Authentication source* is *webserver*. This prevents a header-asserted
identity from ever logging into an account that was created some other
way - most importantly, the default administrator account created by
pgAdmin's own setup, whose *Authentication source* is *internal*.
If you are enabling Webserver authentication on a site that already has
users (including that default administrator) with an *Authentication
source* other than *webserver*, none of them will be able to log in
through Webserver authentication until you change it. To do so, sign in
through another configured authentication source and, for each such
user, set *Authentication source* to *webserver* on the
:ref:`User Management <user_management>` page. If ``AUTHENTICATION_SOURCES``
lists only *webserver*, there is no other source to sign in with -
temporarily add *internal* back to ``AUTHENTICATION_SOURCES``, sign in
with the internal administrator's password, fix the affected users'
*Authentication source*, then remove *internal* again.
See :ref:`Accounts from different authentication sources
<auth_source_accounts>` for more information.
Master Password
===============
+3 -2
View File
@@ -5,8 +5,9 @@ Debian and Ubuntu.
## Supported platforms
* Debian 11, 12 & 13
* Ubuntu 22.04, 24.04 & 25.04
The platforms built are the ones in the matrix in
`.github/workflows/check-deb-build.yml`; see `pkg/linux/PLATFORMS.md` for how
to add or retire one.
## Build configuration
+119 -113
View File
@@ -16,26 +16,24 @@ PUID=${PUID:-5050}
PGID=${PGID:-0}
# Validate PUID/PGID are numeric and in acceptable range
if ! echo "$PUID" | grep -qE '^[0-9]+$'; then
if [[ ! $PUID =~ ^[0-9]+$ ]]; then
echo "ERROR: PUID must be a numeric value, got '$PUID'"
exit 1
fi
if ! echo "$PGID" | grep -qE '^[0-9]+$'; then
if [[ ! $PGID =~ ^[0-9]+$ ]]; then
echo "ERROR: PGID must be a numeric value, got '$PGID'"
exit 1
fi
if [ "$PUID" -eq 0 ]; then
if (( 10#$PUID == 0 )); then
echo "ERROR: PUID=0 (root) is not allowed. Use a non-root UID."
exit 1
fi
if [ "$(id -u)" = "0" ]; then
if (( EUID == 0 )); then
# Ensure a group with the target GID exists
if ! getent group "$PGID" > /dev/null 2>&1; then
if ! addgroup -g "$PGID" pggroup; then
echo "ERROR: Failed to create group with GID=$PGID"
exit 1
fi
if ! getent group "$PGID" &>/dev/null && ! addgroup -g "$PGID" pggroup; then
echo "ERROR: Failed to create group with GID=$PGID"
exit 1
fi
# Reassign the pgadmin user to the desired UID/GID
@@ -46,17 +44,17 @@ if [ "$(id -u)" = "0" ]; then
# Fix ownership of runtime directories BEFORE any initialization
for dir in /run/pgadmin /var/lib/pgadmin; do
if [ -d "$dir" ]; then
if [[ -d $dir ]]; then
chown -R "$PUID:$PGID" "$dir"
fi
done
# Fix ownership of individual files (no -R needed)
if [ -e /pgadmin4/config_distro.py ]; then
if [[ -e /pgadmin4/config_distro.py ]]; then
chown "$PUID:$PGID" /pgadmin4/config_distro.py
fi
if [ -d /certs ]; then
if [[ -d /certs ]]; then
chown -R "$PUID:$PGID" /certs
fi
@@ -66,12 +64,8 @@ else
SU_EXEC=""
# Fixup the passwd file, in case we're on OpenShift
if ! whoami > /dev/null 2>&1; then
if [ "$(id -u)" -ne 5050 ]; then
if [ -w /etc/passwd ]; then
echo "${USER_NAME:-pgadminr}:x:$(id -u):0:${USER_NAME:-pgadminr} user:${HOME}:/sbin/nologin" >> /etc/passwd
fi
fi
if ! whoami &>/dev/null && (( EUID != 5050 )) && [[ -w /etc/passwd ]]; then
echo "${USER_NAME:-pgadminr}:x:${EUID}:0:${USER_NAME:-pgadminr} user:${HOME}:/sbin/nologin" >>/etc/passwd
fi
fi
@@ -103,22 +97,22 @@ if grep -q '^NoNewPrivs:[[:space:]]*1' /proc/self/status 2>/dev/null; then
restricted=1
fi
if [ "$restricted" = "0" ]; then
if (( restricted == 0 )); then
cap_bnd=$(awk '/^CapBnd:/ { print $2 }' /proc/self/status 2>/dev/null)
if [ -n "$cap_bnd" ] && [ "$(( 0x${cap_bnd} & 0x400 ))" -eq 0 ]; then
if [[ -n $cap_bnd ]] && (( (0x$cap_bnd & 0x400) == 0 )); then
restricted=1
fi
fi
if [ "$restricted" = "1" ] || [ ! -x /venv/bin/python3-cap ]; then
if (( restricted == 1 )) || [[ ! -x /venv/bin/python3-cap ]]; then
PYTHON_BIN=/venv/bin/python3
if [ -z "${PGADMIN_LISTEN_PORT}" ]; then
if [ -n "${PGADMIN_ENABLE_TLS}" ]; then
if [[ -z $PGADMIN_LISTEN_PORT ]]; then
if [[ -n $PGADMIN_ENABLE_TLS ]]; then
export PGADMIN_LISTEN_PORT=8443
else
export PGADMIN_LISTEN_PORT=8080
fi
echo "Restricted security context detected; defaulting PGADMIN_LISTEN_PORT to ${PGADMIN_LISTEN_PORT}."
echo "Restricted security context detected; defaulting PGADMIN_LISTEN_PORT to $PGADMIN_LISTEN_PORT."
fi
fi
@@ -126,30 +120,30 @@ fi
# (will allow for "$XYZ_DB_PASSWORD_FILE" to fill in the value of
# "$XYZ_DB_PASSWORD" from a file, for Docker's secrets feature)
function file_env() {
local var="$1"
local fileVar="${var}_FILE"
local def="${2:-}"
if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then
printf >&2 'error: both %s and %s are set (but are exclusive)\n' "$var" "$fileVar"
exit 1
fi
local val="$def"
if [ "${!var:-}" ]; then
val="${!var}"
elif [ "${!fileVar:-}" ] && [ ! -r "${!fileVar}" ]; then
printf >&2 'error: %s is set to "%s" but the file does not exist or is not readable\n' \
"$fileVar" "${!fileVar}"
exit 1
elif [ "${!fileVar:-}" ]; then
val="$(< "${!fileVar}")"
fi
export "$var"="$val"
unset "$fileVar"
local var="$1"
local fileVar="${var}_FILE"
local def="${2:-}"
if [[ -n ${!var:-} && -n ${!fileVar:-} ]]; then
printf >&2 'error: both %s and %s are set (but are exclusive)\n' "$var" "$fileVar"
exit 1
fi
local val="$def"
if [[ -n ${!var:-} ]]; then
val="${!var}"
elif [[ -n ${!fileVar:-} && ! -r ${!fileVar} ]]; then
printf >&2 'error: %s is set to "%s" but the file does not exist or is not readable\n' \
"$fileVar" "${!fileVar}"
exit 1
elif [[ -n ${!fileVar:-} ]]; then
val="$(<"${!fileVar}")"
fi
export "$var"="$val"
unset "$fileVar"
}
# Set values for config variables that can be passed using secrets
if [ -n "${PGADMIN_CONFIG_CONFIG_DATABASE_URI_FILE}" ]; then
file_env PGADMIN_CONFIG_CONFIG_DATABASE_URI
if [[ -n $PGADMIN_CONFIG_CONFIG_DATABASE_URI_FILE ]]; then
file_env PGADMIN_CONFIG_CONFIG_DATABASE_URI
fi
file_env PGADMIN_DEFAULT_PASSWORD
@@ -159,8 +153,8 @@ export CONFIG_DISTRO_FILE_PATH="${PGADMIN_CUSTOM_CONFIG_DISTRO_FILE:-/pgadmin4/c
# provided by the user through the PGADMIN_CONFIG_* environment variables.
# Only update the file on first launch. The empty file is created only in default path during the
# container build so it can have the required ownership.
if [ ! -e "${CONFIG_DISTRO_FILE_PATH}" ] || [ "$(wc -m "${CONFIG_DISTRO_FILE_PATH}" 2>/dev/null | awk '{ print $1 }')" = "0" ]; then
cat << EOF > "${CONFIG_DISTRO_FILE_PATH}"
if [[ ! -e $CONFIG_DISTRO_FILE_PATH || "$(wc -m "$CONFIG_DISTRO_FILE_PATH" 2>/dev/null | awk '{ print $1 }')" == 0 ]]; then
cat <<EOF >"$CONFIG_DISTRO_FILE_PATH"
CA_FILE = '/etc/ssl/certs/ca-certificates.crt'
LOG_FILE = '/dev/null'
HELP_PATH = '../../docs'
@@ -175,22 +169,21 @@ DEFAULT_BINARY_PATHS = {
}
EOF
# This is a bit kludgy, but necessary as the container uses BusyBox/ash as
# it's shell and not bash which would allow a much cleaner implementation
for var in $(env | grep "^PGADMIN_CONFIG_" | cut -d "=" -f 1); do
# Iterate over PGADMIN_CONFIG_* environment variables and writes them to the config file
for var in "${!PGADMIN_CONFIG_@}"; do
# Get the raw value
val=$(eval "echo \"\$$var\"")
val="${!var}"
# This normalization step is what makes 'true', 'True'
case "$(echo "$val" | tr '[:upper:]' '[:lower:]')" in
true) val="True" ;;
false) val="False" ;;
esac
echo "${var#PGADMIN_CONFIG_} = $val" >> "${CONFIG_DISTRO_FILE_PATH}"
if [[ "${val,,}" =~ ^(true|false)$ ]]; then
val="${val,,}"
val="${val^}"
fi
echo "${var#PGADMIN_CONFIG_} = $val" >>"$CONFIG_DISTRO_FILE_PATH"
done
# If running as root with custom config distro path, fix ownership
if [ "$(id -u)" = "0" ] && [ "${CONFIG_DISTRO_FILE_PATH}" != "/pgadmin4/config_distro.py" ]; then
chown "$PUID:$PGID" "${CONFIG_DISTRO_FILE_PATH}"
if (( EUID == 0 )) && [[ $CONFIG_DISTRO_FILE_PATH != "/pgadmin4/config_distro.py" ]]; then
chown "$PUID:$PGID" "$CONFIG_DISTRO_FILE_PATH"
fi
fi
@@ -203,7 +196,7 @@ fi
# "False" default below is preserved so first-launch user setup still
# runs (see #9984).
external_config_db_exists="False"
if [ -n "${PGADMIN_CONFIG_CONFIG_DATABASE_URI}" ]; then
if [[ -n $PGADMIN_CONFIG_CONFIG_DATABASE_URI ]]; then
result=$(cd /pgadmin4/pgadmin/utils && $SU_EXEC /venv/bin/python3 -c "
import os, ast
from check_external_config_db import check_external_config_db
@@ -214,7 +207,7 @@ except (ValueError, SyntaxError):
uri = raw
print(check_external_config_db(uri))
" 2>/dev/null)
if [ -n "$result" ]; then
if [[ -n $result ]]; then
external_config_db_exists="$result"
fi
fi
@@ -225,55 +218,70 @@ function load_server_json_file() {
EXTRA_ARGS=""
if [ "${PGADMIN_REPLACE_SERVERS_ON_STARTUP}" = "True" ]; then
if [[ $PGADMIN_REPLACE_SERVERS_ON_STARTUP == "True" ]]; then
EXTRA_ARGS="--replace"
fi
if [ -f "${PGADMIN_SERVER_JSON_FILE}" ]; then
if [[ -f $PGADMIN_SERVER_JSON_FILE ]]; then
# When running in Desktop mode, no user is created
# so we have to import servers anonymously
if [ "${PGADMIN_CONFIG_SERVER_MODE}" = "False" ]; then
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py load-servers "${PGADMIN_SERVER_JSON_FILE}" ${EXTRA_ARGS}
if [[ $PGADMIN_CONFIG_SERVER_MODE == "False" ]]; then
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py load-servers "$PGADMIN_SERVER_JSON_FILE" $EXTRA_ARGS
else
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py load-servers "${PGADMIN_SERVER_JSON_FILE}" --user "${PGADMIN_DEFAULT_EMAIL}" ${EXTRA_ARGS}
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py load-servers "$PGADMIN_SERVER_JSON_FILE" --user "$PGADMIN_DEFAULT_EMAIL" $EXTRA_ARGS
fi
fi
}
if [ ! -f /var/lib/pgadmin/pgadmin4.db ] && [ "${external_config_db_exists}" = "False" ]; then
if [ -z "${PGADMIN_DEFAULT_EMAIL}" ] || { [ -z "${PGADMIN_DEFAULT_PASSWORD}" ] && [ -z "${PGADMIN_DEFAULT_PASSWORD_FILE}" ]; }; then
if [[ ! -f /var/lib/pgadmin/pgadmin4.db && $external_config_db_exists == "False" ]]; then
if [[ -z $PGADMIN_DEFAULT_EMAIL || (-z $PGADMIN_DEFAULT_PASSWORD && -z $PGADMIN_DEFAULT_PASSWORD_FILE) ]]; then
echo 'You need to define the PGADMIN_DEFAULT_EMAIL and PGADMIN_DEFAULT_PASSWORD or PGADMIN_DEFAULT_PASSWORD_FILE environment variables.'
exit 1
fi
# Validate PGADMIN_DEFAULT_EMAIL
CHECK_EMAIL_DELIVERABILITY="False"
if [ -n "${PGADMIN_CONFIG_CHECK_EMAIL_DELIVERABILITY}" ]; then
CHECK_EMAIL_DELIVERABILITY=${PGADMIN_CONFIG_CHECK_EMAIL_DELIVERABILITY}
#
# The settings and the email address are read inside Python via
# os.environ rather than interpolated into the Python source. Boolean
# settings are normalised in the same way as config_distro.py above, so
# 'true' and 'false' in any case are accepted.
is_valid_email=$(cd /pgadmin4/pgadmin/utils && $SU_EXEC /venv/bin/python3 -c "
import ast, os, sys
from validation_utils import validate_email
def setting(name, default):
raw = os.environ.get('PGADMIN_CONFIG_' + name, '')
if not raw:
return default
if raw.lower() in ('true', 'false'):
return raw.lower() == 'true'
try:
return ast.literal_eval(raw)
except (ValueError, SyntaxError):
return raw
email_config = {
'CHECK_EMAIL_DELIVERABILITY': setting('CHECK_EMAIL_DELIVERABILITY', False),
'ALLOW_SPECIAL_EMAIL_DOMAINS': setting('ALLOW_SPECIAL_EMAIL_DOMAINS', []),
'GLOBALLY_DELIVERABLE': setting('GLOBALLY_DELIVERABLE', True),
}
print(f'email config is {email_config}', file=sys.stderr)
print(validate_email(os.environ['PGADMIN_DEFAULT_EMAIL'], email_config))
") || exit 1
if [[ $is_valid_email == *False* ]]; then
echo "'$PGADMIN_DEFAULT_EMAIL' does not appear to be a valid email address. Please reset the PGADMIN_DEFAULT_EMAIL environment variable and try again."
echo "Validation output: $is_valid_email"
exit 1
fi
ALLOW_SPECIAL_EMAIL_DOMAINS="[]"
if [ -n "${PGADMIN_CONFIG_ALLOW_SPECIAL_EMAIL_DOMAINS}" ]; then
ALLOW_SPECIAL_EMAIL_DOMAINS=${PGADMIN_CONFIG_ALLOW_SPECIAL_EMAIL_DOMAINS}
fi
GLOBALLY_DELIVERABLE="True"
if [ -n "${PGADMIN_CONFIG_GLOBALLY_DELIVERABLE}" ]; then
GLOBALLY_DELIVERABLE=${PGADMIN_CONFIG_GLOBALLY_DELIVERABLE}
fi
email_config="{'CHECK_EMAIL_DELIVERABILITY': ${CHECK_EMAIL_DELIVERABILITY}, 'ALLOW_SPECIAL_EMAIL_DOMAINS': ${ALLOW_SPECIAL_EMAIL_DOMAINS}, 'GLOBALLY_DELIVERABLE': ${GLOBALLY_DELIVERABLE}}"
echo "email config is ${email_config}"
is_valid_email=$(cd /pgadmin4/pgadmin/utils && $SU_EXEC /venv/bin/python3 -c "from validation_utils import validate_email; val = validate_email('${PGADMIN_DEFAULT_EMAIL}', ${email_config}); print(val)")
if echo "${is_valid_email}" | grep "False" > /dev/null; then
echo "'${PGADMIN_DEFAULT_EMAIL}' does not appear to be a valid email address. Please reset the PGADMIN_DEFAULT_EMAIL environment variable and try again."
echo "Validation output: ${is_valid_email}"
exit 1
fi
# Switch back to root directory for further process
cd /pgadmin4
# Set the default username and password in a
# backwards compatible way
export PGADMIN_SETUP_EMAIL="${PGADMIN_DEFAULT_EMAIL}"
export PGADMIN_SETUP_PASSWORD="${PGADMIN_DEFAULT_PASSWORD}"
export PGADMIN_SETUP_EMAIL="$PGADMIN_DEFAULT_EMAIL"
export PGADMIN_SETUP_PASSWORD="$PGADMIN_DEFAULT_PASSWORD"
# Initialize DB before starting Gunicorn
# Importing pgadmin4 (from this script) is enough
@@ -285,41 +293,41 @@ if [ ! -f /var/lib/pgadmin/pgadmin4.db ] && [ "${external_config_db_exists}" = "
load_server_json_file
# Pre-load any required preferences
if [ -f "${PGADMIN_PREFERENCES_JSON_FILE}" ]; then
if [ "${PGADMIN_CONFIG_SERVER_MODE}" = "False" ]; then
if [[ -f $PGADMIN_PREFERENCES_JSON_FILE ]]; then
if [[ $PGADMIN_CONFIG_SERVER_MODE == "False" ]]; then
DESKTOP_USER=$(cd /pgadmin4 && $SU_EXEC /venv/bin/python3 -c 'import config; print(config.DESKTOP_USER)')
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py set-prefs "${DESKTOP_USER}" --input-file "${PGADMIN_PREFERENCES_JSON_FILE}"
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py set-prefs "$DESKTOP_USER" --input-file "$PGADMIN_PREFERENCES_JSON_FILE"
else
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py set-prefs "${PGADMIN_DEFAULT_EMAIL}" --input-file "${PGADMIN_PREFERENCES_JSON_FILE}"
$SU_EXEC /venv/bin/python3 /pgadmin4/setup.py set-prefs "$PGADMIN_DEFAULT_EMAIL" --input-file "$PGADMIN_PREFERENCES_JSON_FILE"
fi
fi
# Copy the pgpass file passed using secrets
if [ -n "${PGPASS_FILE}" ] && [ -f "${PGPASS_FILE}" ]; then
if [ "${PGADMIN_CONFIG_SERVER_MODE}" = "False" ]; then
cp "${PGPASS_FILE}" /var/lib/pgadmin/.pgpass
if [[ -n $PGPASS_FILE && -f $PGPASS_FILE ]]; then
if [[ $PGADMIN_CONFIG_SERVER_MODE == "False" ]]; then
cp "$PGPASS_FILE" /var/lib/pgadmin/.pgpass
chmod 600 /var/lib/pgadmin/.pgpass
# Fix ownership when running as root
if [ "$(id -u)" = "0" ]; then
if (( EUID == 0 )); then
chown "$PUID:$PGID" /var/lib/pgadmin/.pgpass
fi
else
PGADMIN_USER_CONFIG_DIR=$(echo "${PGADMIN_DEFAULT_EMAIL}" | sed 's/@/_/g')
mkdir -p "/var/lib/pgadmin/storage/${PGADMIN_USER_CONFIG_DIR}"
cp "${PGPASS_FILE}" "/var/lib/pgadmin/storage/${PGADMIN_USER_CONFIG_DIR}/.pgpass"
chmod 600 "/var/lib/pgadmin/storage/${PGADMIN_USER_CONFIG_DIR}/.pgpass"
PGADMIN_USER_CONFIG_DIR="${PGADMIN_DEFAULT_EMAIL//@/_}"
mkdir -p "/var/lib/pgadmin/storage/$PGADMIN_USER_CONFIG_DIR"
cp "$PGPASS_FILE" "/var/lib/pgadmin/storage/$PGADMIN_USER_CONFIG_DIR/.pgpass"
chmod 600 "/var/lib/pgadmin/storage/$PGADMIN_USER_CONFIG_DIR/.pgpass"
# Fix ownership when running as root
if [ "$(id -u)" = "0" ]; then
chown -R "$PUID:$PGID" "/var/lib/pgadmin/storage/${PGADMIN_USER_CONFIG_DIR}"
if (( EUID == 0 )); then
chown -R "$PUID:$PGID" "/var/lib/pgadmin/storage/$PGADMIN_USER_CONFIG_DIR"
fi
fi
fi
# If already initialised and PGADMIN_REPLACE_SERVERS_ON_STARTUP is set to true, then load the server json file.
elif [ "${PGADMIN_REPLACE_SERVERS_ON_STARTUP}" = "True" ]; then
elif [[ $PGADMIN_REPLACE_SERVERS_ON_STARTUP == "True" ]]; then
load_server_json_file
fi
# Start Postfix to handle password resets etc.
if [ -z "${PGADMIN_DISABLE_POSTFIX}" ]; then
if [[ -z $PGADMIN_DISABLE_POSTFIX ]]; then
sudo /usr/sbin/postfix start
fi
@@ -330,18 +338,16 @@ TIMEOUT=$(cd /pgadmin4 && $SU_EXEC /venv/bin/python3 -c 'import config; print(co
# NOTE: currently pgadmin can run only with 1 worker due to sessions implementation
# Using --threads to have multi-threaded single-process worker
if [ -n "${PGADMIN_ENABLE_SOCK}" ]; then
if [[ -n $PGADMIN_ENABLE_SOCK ]]; then
BIND_ADDRESS="unix:/run/pgadmin/pgadmin.sock"
elif [[ -n $PGADMIN_ENABLE_TLS ]]; then
BIND_ADDRESS="${PGADMIN_LISTEN_ADDRESS:-[::]}:${PGADMIN_LISTEN_PORT:-443}"
else
if [ -n "${PGADMIN_ENABLE_TLS}" ]; then
BIND_ADDRESS="${PGADMIN_LISTEN_ADDRESS:-[::]}:${PGADMIN_LISTEN_PORT:-443}"
else
BIND_ADDRESS="${PGADMIN_LISTEN_ADDRESS:-[::]}:${PGADMIN_LISTEN_PORT:-80}"
fi
BIND_ADDRESS="${PGADMIN_LISTEN_ADDRESS:-[::]}:${PGADMIN_LISTEN_PORT:-80}"
fi
if [ -n "${PGADMIN_ENABLE_TLS}" ]; then
exec $SU_EXEC "${PYTHON_BIN}" /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --timeout "${TIMEOUT}" --bind "${BIND_ADDRESS}" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" --keyfile /certs/server.key --certfile /certs/server.cert -c gunicorn_config.py run_pgadmin:app
if [[ -n $PGADMIN_ENABLE_TLS ]]; then
exec $SU_EXEC "$PYTHON_BIN" /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --timeout "$TIMEOUT" --bind "$BIND_ADDRESS" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" --keyfile /certs/server.key --certfile /certs/server.cert -c gunicorn_config.py run_pgadmin:app
else
exec $SU_EXEC "${PYTHON_BIN}" /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --limit-request-fields "${GUNICORN_LIMIT_REQUEST_FIELDS:-100}" --limit-request-field_size "${GUNICORN_LIMIT_REQUEST_FIELD_SIZE:-8190}" --timeout "${TIMEOUT}" --bind "${BIND_ADDRESS}" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" -c gunicorn_config.py run_pgadmin:app
exec $SU_EXEC "$PYTHON_BIN" /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --limit-request-fields "${GUNICORN_LIMIT_REQUEST_FIELDS:-100}" --limit-request-field_size "${GUNICORN_LIMIT_REQUEST_FIELD_SIZE:-8190}" --timeout "$TIMEOUT" --bind "$BIND_ADDRESS" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" -c gunicorn_config.py run_pgadmin:app
fi
+8
View File
@@ -5,6 +5,14 @@ from config import JSON_LOGGER, CONSOLE_LOG_LEVEL, CONSOLE_LOG_FORMAT_JSON
gunicorn.SERVER_SOFTWARE = "Python"
# Include the authenticated user identity in the access log.
# %({x-remote-user}o)s reads the X-Remote-User response header set by pgAdmin
# for authenticated requests; unauthenticated requests log '-'.
access_log_format = (
'%(h)s %(l)s %({x-remote-user}o)s %(t)s "%(r)s" %(s)s %(b)s '
'"%(f)s" "%(a)s"'
)
if JSON_LOGGER:
logconfig_dict = {
"version": 1,
+2 -2
View File
@@ -1,7 +1,7 @@
apiVersion: v2
name: pgadmin4-helm
version: 9.16.0
appVersion: 9.16.0
version: 9.19.0
appVersion: 9.19.0
description: pgAdmin is the most popular and feature rich Open Source administration and development platform for PostgreSQL, the most advanced Open Source database in the world.
home: https://pgadmin.org
sources: ["https://github.com/pgadmin-org/pgadmin4/tree/master/helm"]
+7
View File
@@ -35,11 +35,18 @@ The chart should dump its version and appVersion in the Chart.yaml file every re
| `preferences.data` | Preferences to load | `{}` |
| `resources.*` | Allocated requests and limits resources | `{"requests": {...}, "limits": {...}}` |
| `persistence.enabled` | PVC resource creation | `true` |
| `persistence.existingClaim` | Provide existing PVC instead of creating one | `""` |
| `service.type` | Service type | `"ClusterIP"` |
| `service.loadBalancerIP` | Load balancer IP (Only if service.type is LoadBalancer) | `""` |
| `ingress.enabled` | Ingress resource creation | `false` |
| `ingress.hostname` | Ingress resource hostname | `"pgadmin4.local"` |
| `ingress.tlsSecret` | Ingress tls secret name | `""` |
| `httpRoute.enabled` | Gateway API HTTPRoute resource creation | `false` |
| `httpRoute.apiVersion` | HTTPRoute apiVersion (override for v1beta1 implementations) | `"gateway.networking.k8s.io/v1"` |
| `httpRoute.parentRefs` | Gateway(s) the route attaches to (required when `httpRoute.enabled` is true) | `[]` |
| `httpRoute.hostnames` | HTTPRoute hostnames (falls back to `ingress.hostname` when empty) | `[]` |
| `httpRoute.annotations` | HTTPRoute annotations | `{}` |
| `httpRoute.rules` | Custom routing rules (defaults to a single `/` PathPrefix rule to the service) | `[]` |
| `strategy.type` | Deployment strategy type (RollingUpdate or Recreate) | Kubernetes default (RollingUpdate) |
| `strategy.rollingUpdate.maxSurge` | Maximum number of pods that can be created over the desired replicas | Kubernetes default (25%) |
| `strategy.rollingUpdate.maxUnavailable` | Maximum number of pods that can be unavailable during the update | Kubernetes default (25%) |
+3 -3
View File
@@ -32,12 +32,12 @@ spec:
{{- with omit .Values.commonLabels "app" }}
{{- . | toYaml | nindent 8 }}
{{- end }}
{{- if or (not (empty .Values.commonAnnotations)) (not .Values.existingSecret) .Values.preferences.enabled .Values.serverDefinitions.enabled }}
{{- if or (not (empty .Values.commonAnnotations)) (empty .Values.auth.existingSecret) .Values.preferences.enabled .Values.serverDefinitions.enabled }}
annotations:
{{- with .Values.commonAnnotations }}
{{- . | toYaml | nindent 8 }}
{{- end }}
{{- if not .Values.existingSecret }}
{{- if empty .Values.auth.existingSecret }}
checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
{{- end }}
{{- if and .Values.config_local.enabled (empty .Values.config_local.existingSecret) }}
@@ -66,7 +66,7 @@ spec:
{{- if .Values.persistence.enabled }}
- name: data
persistentVolumeClaim:
claimName: {{ template "pgadmin4.fullname" . }}
claimName: {{ .Values.persistence.existingClaim | default (include "pgadmin4.fullname" .) }}
{{- end }}
{{- if .Values.config_local.enabled }}
- name: config-local
+39
View File
@@ -0,0 +1,39 @@
{{- if .Values.httpRoute.enabled }}
{{- if not .Values.httpRoute.parentRefs }}
{{- fail "httpRoute.parentRefs must be set when httpRoute.enabled is true" }}
{{- end }}
apiVersion: {{ .Values.httpRoute.apiVersion | default "gateway.networking.k8s.io/v1" }}
kind: HTTPRoute
metadata:
name: {{ template "pgadmin4.fullname" . }}
{{- with .Values.commonLabels }}
labels: {{ . | toYaml | nindent 4 }}
{{- end }}
{{- if or .Values.httpRoute.annotations .Values.commonAnnotations }}
annotations: {{ merge .Values.httpRoute.annotations .Values.commonAnnotations | toYaml | nindent 4 }}
{{- end }}
spec:
parentRefs: {{- toYaml .Values.httpRoute.parentRefs | nindent 4 }}
{{- $hostnames := .Values.httpRoute.hostnames }}
{{- if and (not $hostnames) .Values.ingress.hostname }}
{{- $hostnames = list (tpl .Values.ingress.hostname .) }}
{{- end }}
{{- with $hostnames }}
hostnames: {{- toYaml . | nindent 4 }}
{{- end }}
rules:
{{- if .Values.httpRoute.rules }}
{{- toYaml .Values.httpRoute.rules | nindent 4 }}
{{- else }}
- matches:
- path:
type: PathPrefix
value: /
backendRefs:
- group: ''
kind: Service
name: {{ template "pgadmin4.fullname" . }}
port: {{ .Values.service.port }}
weight: 1
{{- end }}
{{- end }}
+2 -2
View File
@@ -1,4 +1,4 @@
{{- if .Values.persistence.enabled }}
{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
@@ -17,4 +17,4 @@ spec:
requests:
storage: {{ .Values.persistence.size }}
accessModes: {{ .Values.persistence.accessModes }}
{{- end }}
{{- end }}
+20 -1
View File
@@ -88,6 +88,7 @@ persistence:
size: 1Gi
storageClass: ""
accessModes: ["ReadWriteOnce"]
existingClaim: ""
service:
type: ClusterIP
@@ -106,6 +107,25 @@ ingress:
annotations: {}
# If set, enables TLS configuration in the Ingress resource.
tlsSecret: ""
httpRoute:
# Enable a Gateway API HTTPRoute as an alternative to the Ingress above.
enabled: false
# apiVersion for the HTTPRoute resource. Override if your Gateway API
# implementation still serves the resource under v1beta1.
apiVersion: gateway.networking.k8s.io/v1
# parentRefs is required when httpRoute.enabled is true. It references the
# Gateway (and optionally a listener) that should route to pgAdmin.
parentRefs: []
# - name: my-gateway
# namespace: gateway-system
# sectionName: https
# hostnames for the route. When empty, falls back to ingress.hostname.
hostnames: []
# - pgadmin4.example.com
annotations: {}
# Custom routing rules. When empty, a single rule forwards all traffic
# ("/" PathPrefix) to the pgAdmin service.
rules: []
startupProbe:
enabled: false
httpGet:
@@ -160,4 +180,3 @@ containerSecurityContext:
type: RuntimeDefault
windowsOptions:
hostProcess: false
+174
View File
@@ -0,0 +1,174 @@
# Adding and retiring Linux platforms
Debian, Ubuntu, Fedora and EL releases come and go several times a year, and
each one is named in more places than is obvious: the build matrices, the
staging and release workflows, the acceptance tests and the publishing wrapper
on the servers all carry their own list. Missing one does not always fail
loudly (a platform the wrapper does not know about is built, uploaded and then
quietly left unindexed), so work through the whole of the relevant section
below rather than stopping when CI goes green.
Architectures are a different change, and are not covered here; see the
comments on the RPM tree in `.github/workflows/snapshot.yml`, `YUM_TARGETS` in
`pkg/publish/pga-publish` and `Architectures` in `pkg/publish/aptftp.conf`.
## Where platforms are named
| File | What it holds | Naming |
|---|---|---|
| `.github/workflows/check-deb-build.yml` | The DEB build matrix, which the snapshot and release candidate workflows call | `debian-13`, `ubuntu-2604`, plus the container image |
| `.github/workflows/check-rpm-build.yml` | The RPM build matrix, likewise | `el-10`, `fedora-44`, plus the image and the PGDG repository RPM URL |
| `.github/workflows/snapshot.yml` | `codename_for()`, mapping DEB build names to codenames; the `case` mapping RPM build names to repository trees | `ubuntu-2604` to `resolute`; `el-10` to `redhat/rhel-10` |
| `.github/workflows/release-candidate.yml` | The same two mappings, duplicated | as above |
| `.github/workflows/acceptance-test.yml` | The install test matrices, which add the published repositories and install from them | `resolute`; `rhel-10`, `fedora-44` |
| `.github/workflows/promote-release.yml` | The `rebuild-apt` and `rebuild-yum` calls in "Publish the packages" | `resolute`; `redhat rhel 10 x86_64` |
| `pkg/publish/pga-publish` | `APT_CODENAMES` and `YUM_TARGETS`, which decide what the servers create, index and promote | as `promote-release.yml` |
These do not need changing for a new release of an existing distribution:
* The repository configuration RPMs (`pkg/redhat/repo-rpm.sh`), which use
`$releasever` rather than naming versions.
* The repository READMEs, whose platform tables `install-repo-readme.py`
derives from the trees on disk and the archive bucket.
* The DEB and RPM build scripts, unless the new release needs something
different; see 'Version-specific code' below.
## Adding a platform
### Before starting
Check that the pieces the build depends on exist for the new release:
* The container image on Docker Hub (`ubuntu:26.04`, `fedora:45`,
`almalinux:11`). New Ubuntu releases usually have a tag some weeks before
release; building against a pre-release image is fine for proving the build,
but do not publish packages from one.
* For RPM platforms, the PGDG repository RPM
(`https://download.postgresql.org/pub/repos/yum/reporpms/`), since the build
takes `libpq5-devel` and `postgresql18-devel` from PGDG. On EL, EPEL must
also exist for the new version. DEB builds use the distribution's own
`libpq-dev` and have no equivalent dependency.
* The codename, for DEB platforms: it is what `lsb_release -cs` prints and
what the repository directory is called, so take it from the release itself
rather than from the version number.
### In this repository
All of this goes in one pull request. The DEB and RPM checks do not run on
pull requests, only on pushes to `master` and on dispatch, so prove the new
matrix leg before merging by dispatching `check-deb-build.yml` or
`check-rpm-build.yml` against the branch in a fork with Actions enabled
(`gh workflow run check-deb-build.yml --ref <branch>`).
1. Add the matrix leg to `check-deb-build.yml` or `check-rpm-build.yml`,
copying the neighbouring entry's form exactly. The `name` becomes part of
the artifact name, and the mappings below parse it back out.
2. Add the mapping for the new name to `snapshot.yml` and to
`release-candidate.yml`. A DEB name with no `codename_for()` entry fails
the assemble job with `Unknown Debian build name`; an RPM name that is not
`el-*` or `fedora-*` fails with `Unknown RPM build name`.
3. Add the platform to both matrices in `acceptance-test.yml`.
4. Add the `rebuild-apt` codename, or the `rebuild-yum` line, to "Publish the
packages" in `promote-release.yml`.
5. Add the codename to `APT_CODENAMES`, or the tuple to `YUM_TARGETS`, in
`pkg/publish/pga-publish`. The wrapper refuses to index anything not in
these tables, and the snapshot and staging indexers only look for the trees
they name, so without this the new packages are uploaded but never indexed,
and `packages-fetch` never carries them into the live repository.
If the build needs a platform-specific change (a package renamed, a new
AppArmor rule, a different Python), make it in the same pull request, so that
the new matrix leg proves it.
### On the servers
`pga-publish` and the scripts beside it are installed by hand on both the
staging and the download servers, as described under "Installing" in
`pkg/publish/README.md`. Reinstall them on both once the pull request is
merged, and before the next snapshot, since the snapshot and release candidate
workflows build the new platform from then on and the servers will skip what
their installed copy of the tables does not name.
### Proving it
1. Dispatch a publishing snapshot (`gh workflow run snapshot.yml -f
publish=true`), and check that the new platform's tree in the snapshot has
signed indices (`InRelease` for APT, `repodata/repomd.xml.asc` for YUM), and that
the snapshot's README lists it.
2. Install from the snapshot on the new platform, following that README.
3. The first release candidate's acceptance test installs it from the staging
repository, which is the check that matters before promotion.
### The first release that carries it
`rebuild-readme` builds the production README's history from the archive
bucket, and exits with `<platform> is published but absent from the archive`
when a platform in the live tree has never been copied there. Promotion runs
`rebuild-readme` in "Publish the packages", before `sync-s3` copies the
release to the archive in "Update the website", so the first promotion after
adding a platform fails at that point, with the packages already live but the
website not updated. Until that ordering is changed, expect it: run
`pga-publish sync-s3` by hand on the download server, then rerun
`pga-publish rebuild-readme` for the affected kind and finish the website
steps.
### Elsewhere
The download pages on www.pgadmin.org list the supported platforms, and live
outside this repository. Open an issue for the platform, too, so that the
pre-release pass picks it up for the release notes, as with `Issue #9263`
("Added Ubuntu 25.10 and Fedora 43") in `release_notes_9_11.rst`.
## Retiring a platform
A platform is retired when it stops receiving builds. Its repository keeps
serving the last packages it had until somebody removes the tree, and the
archive bucket keeps them after that, since `sync-s3` never deletes.
### In this repository
Reverse steps 1 to 5 of adding a platform, in a single pull request: the
matrix leg, both mappings, both acceptance test entries, the promotion
`rebuild-*` line and the wrapper table entry. Then remove any version-specific
code that only existed for that platform (see below).
Keep the steps together. A platform removed from the wrapper tables but still
in the build matrices is built and uploaded, then silently left out of the
indices and the promotion.
Reinstall the wrapper on both servers once it is merged, as when adding one.
### On the download server
Nothing is removed automatically, and the production README will go on
listing the platform as supported for as long as its tree holds packages,
since it takes the supported list from the trees that exist. To move it to the
"no longer supported" table:
1. Make sure the archive bucket has the platform's last release, which it will
if `sync-s3` has run since that release was promoted.
2. Remove the tree from the live repository: `apt/<codename>` for APT, or
`yum/<family>/<name>-<version>-<arch>` and its `Server`, `Workstation` and
`Client` compatibility links for YUM.
3. Run `pga-publish rebuild-readme apt` or `yum`.
When to do this is a policy decision rather than a mechanical one: users who
have not upgraded their distribution lose `apt update`/`dnf update` access to
pgAdmin the moment the tree goes.
## Version-specific code
The build scripts branch on the distribution version in a few places. Check
them when adding a platform, and delete the dead branches when retiring one:
* `pkg/debian/build.sh`: the AppArmor profile and `postinst` for Ubuntu 24 and
later.
* `pkg/linux/build-functions.sh`: the EL 8 Python selection, in `_setup_env`
and `_copy_code`.
* `pkg/redhat/setup.sh` and `pkg/debian/setup.sh`: prerequisites for building
by hand. CI does not run these (the workflows install their own), so they
are the likeliest to be out of date; `pkg/redhat/setup.sh`, for example,
only knows EL 8 and 9.
* The comments in `check-deb-build.yml` and `check-rpm-build.yml`, which name
the releases their workarounds apply to (PEP 668, dnf5, the distribution's
Node.js on Ubuntu 26.04).
+3
View File
@@ -5,3 +5,6 @@ various Linux distributions.
You should not use them directly, but the functionality provided can be used to
simplify your own build scripts (typically by sourcing *build-functions.sh*).
Adding or retiring a Linux platform touches more than the build scripts; see
*PLATFORMS.md* for everywhere a platform is named.
+93 -15
View File
@@ -68,11 +68,58 @@ _create_python_virtualenv() {
mkdir -p "usr/${APP_NAME}"
cd "usr/${APP_NAME}" || exit
# Create the blank venv
"${SYSTEM_PYTHON_PATH}" -m venv --system-site-packages venv
# Capture the system site-packages dirs *before* creating the venv -
# we need OS-provided packages not available as clean pip wheels on
# every target platform (e.g. dbus-python: needs libdbus-1-dev to
# build from source, no reliable prebuilt wheel, but is a hard
# runtime dependency - see pkg/debian/build.sh's python3-dbus dep).
SYSTEM_SITE_DIRS=$("${SYSTEM_PYTHON_PATH}" -c \
"import site; print('\n'.join(site.getsitepackages()))")
# Create the blank venv WITHOUT --system-site-packages. That flag
# uses Python's site.addsitedir() under the hood, which doesn't just
# add the directory to sys.path - it also scans it for every *.pth
# file and executes any "import ..." lines found inside them. A
# stale, improperly-uninstalled package's namespace-package .pth
# hook (legacy pip/setuptools mechanism) left in the system
# site-packages runs arbitrary code at interpreter startup, before
# core stdlib is guaranteed to resolve. A leftover
# sphinxcontrib-jsmath nspkg.pth on the el-10 build node corrupted
# sys.path early enough to break pip's own subprocess bootstrap,
# failing the whole build with a misleading "No module named
# 'importlib'"/"'traceback'" error (pgadmin4-rpm-build #176/#177).
#
# We can't just delete that file - it's in a root-owned system
# directory on a build node shared by other jobs, and the build
# user isn't guaranteed to have write access there (confirmed: our
# first attempt at deleting it silently no-opped on el-10).
#
# Instead, get the same "OS-provided packages are importable" result
# via a mechanism that doesn't trigger a .pth scan: a *plain path
# line* (no "import") in a .pth file only appends that directory to
# sys.path - it does NOT recursively scan it for further .pth files.
# Write the system site-packages dirs as plain lines into a .pth
# file inside the venv's own site-packages (which we do own), added
# once pip/wheel are installed below.
"${SYSTEM_PYTHON_PATH}" -m venv venv
# Python 3.14's venv module adds a novelty "𝜋thon" alias (U+1D70B, see
# CPython gh-119535) alongside python/python3/python3.X. Nothing uses it,
# and the "sed -i" hash bang fixup below turns the symlink into a full
# copy of the interpreter which, unlike the python* links, is never put
# back. dpkg on Ubuntu 26.04 then fails to unpack it with EPERM (#10414),
# so remove it. The name is given as raw UTF-8 bytes so that it matches
# whatever the build shell's locale is.
rm -f "venv/bin/"$'\360\235\234\213'"thon"
# shellcheck disable=SC1091
. venv/bin/activate
VENV_SITE_PACKAGES=$(python3 -c \
"import sysconfig; print(sysconfig.get_path('purelib'))")
echo "${SYSTEM_SITE_DIRS}" > \
"${VENV_SITE_PACKAGES}/system-site-packages.pth"
# Make sure we have the wheel package present, as well as the latest pip
pip3 install --upgrade pip
pip3 install wheel
@@ -100,6 +147,11 @@ _create_python_virtualenv() {
--no-binary psycopg -r "${SOURCEDIR}/requirements.txt"
fi
# Remove the files in the installed packages that we never use, and the
# packaging tools (pip, setuptools and wheel) that are only needed to
# build the environment
python3 "${SOURCEDIR}/pkg/prune_site_packages.py" venv || exit 1
# Fixup the paths in the venv activation scripts
sed -i 's/VIRTUAL_ENV=.*/VIRTUAL_ENV="\/usr\/pgadmin4\/venv"/g' venv/bin/activate
sed -i 's/setenv VIRTUAL_ENV .*/setenv VIRTUAL_ENV "\/usr\/pgadmin4\/venv"/g' venv/bin/activate.csh
@@ -165,14 +217,32 @@ _build_runtime() {
ELECTRON_ARCH="arm64"
fi
# Resolve the electron version from runtime/package.json, NOT from
# `npm info electron version`. The latter fetches whatever currently
# carries the `latest` dist-tag on the npm registry, which means any
# newly published electron release lands in shipped binaries without
# review. Keep the build deterministic and pinned.
ELECTRON_VERSION=$(sed -nE 's/.*"electron":[[:space:]]*"\^?([0-9.]+)".*/\1/p' "${SOURCEDIR}/runtime/package.json" | head -1)
# Resolve the electron version from runtime/yarn.lock, NOT from the npm
# registry and NOT from the range in runtime/package.json. The registry's
# `latest` dist-tag lands any newly published electron release in shipped
# binaries without review, whilst the package.json range is only a lower
# bound, so yarn is free to resolve it to a build other than the one we
# ship. The lockfile is the single source of truth, and `yarn info` reports
# its resolution without touching the network or needing node_modules.
#
# It must run inside runtime/ though: outside a yarn project, `yarn info`
# silently falls back to querying the registry and still exits 0, so check
# the lockfile is present first and validate what comes back.
if [ ! -f "${SOURCEDIR}/runtime/yarn.lock" ]; then
echo "ERROR: ${SOURCEDIR}/runtime/yarn.lock not found; cannot resolve the pinned electron version" >&2
exit 1
fi
ELECTRON_VERSION=$(cd "${SOURCEDIR}/runtime" && yarn info electron --json | node -e "
const lines = require('fs').readFileSync(0, 'utf8').split('\n').filter(Boolean);
const pkg = lines.map(l => { try { return JSON.parse(l); } catch (e) { return null; } })
.find(o => o && typeof o.value === 'string' && o.value.startsWith('electron@npm:'));
const version = (pkg && pkg.children && pkg.children.Version) || '';
process.stdout.write(/^[0-9]+[.][0-9]+[.][0-9]+(-[0-9A-Za-z.-]+)?$/.test(version) ? version : '');
")
if [ -z "${ELECTRON_VERSION}" ]; then
echo "ERROR: could not resolve electron version from runtime/package.json" >&2
echo "ERROR: could not resolve the pinned electron version from ${SOURCEDIR}/runtime/yarn.lock" >&2
exit 1
fi
@@ -209,8 +279,12 @@ _build_runtime() {
# Install the runtime node_modules
pushd "${BUNDLEDIR}/resources/app" > /dev/null || exit
yarn set version berry
yarn set version 4
YARN_VERSION=$(node -p "require('./package.json').packageManager.split('@')[1]")
if [ -z "${YARN_VERSION}" ]; then
echo "ERROR: Could not determine Yarn version from package.json packageManager field."
exit 1
fi
yarn set version "${YARN_VERSION}"
yarn workspaces focus --production
# remove the yarn cache
@@ -257,9 +331,13 @@ _copy_code() {
find "${SERVERROOT}/usr/${APP_NAME}/venv/" -name "_tkinter*" -print0 | xargs -0 rm -rf
pushd "${SOURCEDIR}/web" > /dev/null || exit
yarn set version berry
yarn set version 4
yarn install
YARN_VERSION=$(node -p "require('./package.json').packageManager.split('@')[1]")
if [ -z "${YARN_VERSION}" ]; then
echo "ERROR: Could not determine Yarn version from package.json packageManager field."
exit 1
fi
yarn set version "${YARN_VERSION}"
yarn install --immutable
yarn run bundle
popd > /dev/null || exit
@@ -268,7 +346,7 @@ _copy_code() {
cp "${SOURCEDIR}/pkg/linux/config_distro.py" "${SERVERROOT}/usr/${APP_NAME}/web/"
cd "${SERVERROOT}/usr/${APP_NAME}/web/" || exit
rm -f pgadmin4.db config_local.*
rm -rf jest.config.js babel.* package.json .yarn* yarn* .editorconfig .eslint* node_modules/ regression/ tools/ pgadmin/static/js/generated/.cache
rm -rf jest.config.js babel.* package.json .yarn* yarn* webpack.* .editorconfig .eslint* node_modules/ regression/ tools/ pgadmin/static/js/generated/.cache
find . -name "tests" -type d -print0 | xargs -0 rm -rf
find . -name "feature_tests" -type d -print0 | xargs -0 rm -rf
find . -name "__pycache__" -type d -print0 | xargs -0 rm -rf
Binary file not shown.
+2
View File
@@ -12,6 +12,8 @@
<string>%APPNAME%</string>
<key>CFBundleIconFile</key>
<string>app.icns</string>
<key>CFBundleIconName</key>
<string>pgAdmin4</string>
<key>CFBundleIdentifier</key>
<string>%APPID%</string>
<key>CFBundleInfoDictionaryVersion</key>
Loaded 100 of 869 files, more files were not shown because too many files have changed in this diff. Show more