Skip to content

pgwire: refactor+simplify the connection set-up code #43837

Merged
craig[bot] merged 2 commits intocockroachdb:masterfrom
knz:20200108-auth
Jan 9, 2020
Merged

pgwire: refactor+simplify the connection set-up code #43837
craig[bot] merged 2 commits intocockroachdb:masterfrom
knz:20200108-auth

Conversation

@knz
Copy link
Copy Markdown
Contributor

@knz knz commented Jan 9, 2020

Ahead of handling #31113.

The early SQL connection start-up sequence was a bit too deep in
nested conditionals.

The conditionals historically grew as special cases on top of special
cases; however taking a step back it turns out the overall flow of the
start-up is quite simple and the code should reflect that. (This makes
it both more readable and more easy to troubleshoot and extend.)

No functional change.

make `handleAuthentication()` handle all of authentication, instead of
sharing the logic with `conn.go`.

Release note: None
@knz knz requested a review from madelynnblue January 9, 2020 00:25
@cockroach-teamcity
Copy link
Copy Markdown
Member

This change is Reviewable

The early SQL connection start-up sequence was a bit too deep in
nested conditionals.

The conditionals historically grew as special cases on top of special
cases; however taking a step back it turns out the overall flow of the
start-up is quite simple and the code should reflect that. (This makes
it both more readable and more easy to troubleshoot and extend.)

No functional change.

Release note: none
@knz
Copy link
Copy Markdown
Contributor Author

knz commented Jan 9, 2020

thank you!

bors r+

@craig
Copy link
Copy Markdown
Contributor

craig bot commented Jan 9, 2020

Build failed (retrying...)

craig bot pushed a commit that referenced this pull request Jan 9, 2020
43837: pgwire: refactor+simplify the connection set-up code  r=knz a=knz

Ahead of handling #31113.
 
The early SQL connection start-up sequence was a bit too deep in
nested conditionals.

The conditionals historically grew as special cases on top of special
cases; however taking a step back it turns out the overall flow of the
start-up is quite simple and the code should reflect that. (This makes
it both more readable and more easy to troubleshoot and extend.)

No functional change.

Co-authored-by: Raphael 'kena' Poss <knz@thaumogen.net>
@craig
Copy link
Copy Markdown
Contributor

craig bot commented Jan 9, 2020

Build succeeded

@craig craig bot merged commit e1b7826 into cockroachdb:master Jan 9, 2020
@knz knz deleted the 20200108-auth branch January 9, 2020 20:52
craig bot pushed a commit that referenced this pull request Jan 9, 2020
43848: pgwire: properly support unix socket clients with authentication r=knz a=knz

Fixes #31113. cc @rolandcrosby 
(All commits except for the last from #43837 and #43843)

tldr: this patch makes unix sockets more production-ready,
by enabling clients to use unix sockets in secure mode
and enabling authentication over unix sockets.

**Motivation:**

[Unix domain
sockets](https://en.wikipedia.org/wiki/Unix_domain_socket) are a way
for a server process to accept direct in-memory connections from
processes running on the same machine as the server. They are simpler
and faster as they avoid the TCP/IP stack entirely.

Unix sockets are used both to provide a local client interface
for administrator users operating the system; as well as
setting up more complex authentication systems using the following
topology:

```
         client
           ^
           |
     (non-standard protocol)
           |
.----------|--------------(server machine)--------------------------.
|          v                                                        |
| ,----------------------.                   ,--------------------. |
| |  connection proxy    |                   | server process     | |
| |  and transport-level |<--(unix socket)-->| and authentication | |
| |   security           |                   | (e.g. crdb)        | |
| `----------------------'                   `--------------------' |
`-------------------------------------------------------------------'
```

**Description of this change:**

CockroachDB already supports setting up a unix socket for use by
clients running on the same machine, subject to regular Unix
permission checks.

Prior to this patch, support for unix sockets was incomplete:

- it would work properly for insecure nodes/clusters; however, ...
- ... in secure mode, it would also require a TLS handshake over
  the unix socket, which is neither supported by pg clients
  nor meaningful: unix domain sockets have transport-level
  security already.

This patch extends/fixes support for unix sockets as follows:

- it properly accepts client connections without TLS over
  unix sockets;
- it subjects incoming unix socket connections to the standard HBA
  rule-based authentication selection (via the cluster setting
  `server.host_based_authentication.configuration`);
- it changes the default HBA configuration to contain
  a default `local` rule that requires password
  authentication, in a way compatible with PostgreSQL;
- it un-hides the `--socket` parameter from the output of
  `cockroach start --help`.

Release note (cli change): Connections using Unix sockets are now
accepted even when the server is running in secure more.
(Consult `cockroach start --help` for details about the `--socket`
parameter.)

Release note (security): Connections using unix sockets are now
subject to the HBA rules defined via the setting
`server.host_based_authentication.configuration`, in a way compatible
with PostgreSQL: incoming unix connections match `local` rules,
whereas incoming TCP connections match `host` rules.
The default HBA configuration used when the cluster
setting is empty is now:

    host      all root all cert
    host      all all  all cert-password
    local     all all      password

Co-authored-by: Raphael 'kena' Poss <knz@thaumogen.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants