mirror of
https://github.com/matrix-org/dendrite
synced 2024-12-17 08:33:31 +00:00
bf7e85848b
* Rename serverkeyapi to signingkeyserver We use "api" for public facing stuff and "server" for internal stuff. As the server key API is internal only, we call it 'signing key server', which also clarifies the type of key (as opposed to TLS keys, E2E keys, etc) * Convert docker/scripts to use signing-key-server * Rename missed bits
159 lines
5.1 KiB
Go
159 lines
5.1 KiB
Go
// Copyright 2017-2018 New Vector Ltd
|
|
// Copyright 2019-2020 The Matrix.org Foundation C.I.C.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package sqlite3
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
|
|
"github.com/matrix-org/dendrite/internal/sqlutil"
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
)
|
|
|
|
const serverKeysSchema = `
|
|
-- A cache of signing keys downloaded from remote servers.
|
|
CREATE TABLE IF NOT EXISTS keydb_server_keys (
|
|
-- The name of the matrix server the key is for.
|
|
server_name TEXT NOT NULL,
|
|
-- The ID of the server key.
|
|
server_key_id TEXT NOT NULL,
|
|
-- Combined server name and key ID separated by the ASCII unit separator
|
|
-- to make it easier to run bulk queries.
|
|
server_name_and_key_id TEXT NOT NULL,
|
|
-- When the key is valid until as a millisecond timestamp.
|
|
-- 0 if this is an expired key (in which case expired_ts will be non-zero)
|
|
valid_until_ts BIGINT NOT NULL,
|
|
-- When the key expired as a millisecond timestamp.
|
|
-- 0 if this is an active key (in which case valid_until_ts will be non-zero)
|
|
expired_ts BIGINT NOT NULL,
|
|
-- The base64-encoded public key.
|
|
server_key TEXT NOT NULL,
|
|
UNIQUE (server_name, server_key_id)
|
|
);
|
|
|
|
CREATE INDEX IF NOT EXISTS keydb_server_name_and_key_id ON keydb_server_keys (server_name_and_key_id);
|
|
`
|
|
|
|
const bulkSelectServerKeysSQL = "" +
|
|
"SELECT server_name, server_key_id, valid_until_ts, expired_ts, " +
|
|
" server_key FROM keydb_server_keys" +
|
|
" WHERE server_name_and_key_id IN ($1)"
|
|
|
|
const upsertServerKeysSQL = "" +
|
|
"INSERT INTO keydb_server_keys (server_name, server_key_id," +
|
|
" server_name_and_key_id, valid_until_ts, expired_ts, server_key)" +
|
|
" VALUES ($1, $2, $3, $4, $5, $6)" +
|
|
" ON CONFLICT (server_name, server_key_id)" +
|
|
" DO UPDATE SET valid_until_ts = $4, expired_ts = $5, server_key = $6"
|
|
|
|
type serverKeyStatements struct {
|
|
db *sql.DB
|
|
writer sqlutil.Writer
|
|
bulkSelectServerKeysStmt *sql.Stmt
|
|
upsertServerKeysStmt *sql.Stmt
|
|
}
|
|
|
|
func (s *serverKeyStatements) prepare(db *sql.DB, writer sqlutil.Writer) (err error) {
|
|
s.db = db
|
|
s.writer = writer
|
|
_, err = db.Exec(serverKeysSchema)
|
|
if err != nil {
|
|
return
|
|
}
|
|
if s.bulkSelectServerKeysStmt, err = db.Prepare(bulkSelectServerKeysSQL); err != nil {
|
|
return
|
|
}
|
|
if s.upsertServerKeysStmt, err = db.Prepare(upsertServerKeysSQL); err != nil {
|
|
return
|
|
}
|
|
return
|
|
}
|
|
|
|
func (s *serverKeyStatements) bulkSelectServerKeys(
|
|
ctx context.Context,
|
|
requests map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp,
|
|
) (map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult, error) {
|
|
nameAndKeyIDs := make([]string, 0, len(requests))
|
|
for request := range requests {
|
|
nameAndKeyIDs = append(nameAndKeyIDs, nameAndKeyID(request))
|
|
}
|
|
results := make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult, len(requests))
|
|
iKeyIDs := make([]interface{}, len(nameAndKeyIDs))
|
|
for i, v := range nameAndKeyIDs {
|
|
iKeyIDs[i] = v
|
|
}
|
|
|
|
err := sqlutil.RunLimitedVariablesQuery(
|
|
ctx, bulkSelectServerKeysSQL, s.db, iKeyIDs, sqlutil.SQLite3MaxVariables,
|
|
func(rows *sql.Rows) error {
|
|
for rows.Next() {
|
|
var serverName string
|
|
var keyID string
|
|
var key string
|
|
var validUntilTS int64
|
|
var expiredTS int64
|
|
if err := rows.Scan(&serverName, &keyID, &validUntilTS, &expiredTS, &key); err != nil {
|
|
return fmt.Errorf("bulkSelectServerKeys: %v", err)
|
|
}
|
|
r := gomatrixserverlib.PublicKeyLookupRequest{
|
|
ServerName: gomatrixserverlib.ServerName(serverName),
|
|
KeyID: gomatrixserverlib.KeyID(keyID),
|
|
}
|
|
vk := gomatrixserverlib.VerifyKey{}
|
|
err := vk.Key.Decode(key)
|
|
if err != nil {
|
|
return fmt.Errorf("bulkSelectServerKeys: %v", err)
|
|
}
|
|
results[r] = gomatrixserverlib.PublicKeyLookupResult{
|
|
VerifyKey: vk,
|
|
ValidUntilTS: gomatrixserverlib.Timestamp(validUntilTS),
|
|
ExpiredTS: gomatrixserverlib.Timestamp(expiredTS),
|
|
}
|
|
}
|
|
return nil
|
|
},
|
|
)
|
|
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return results, nil
|
|
}
|
|
|
|
func (s *serverKeyStatements) upsertServerKeys(
|
|
ctx context.Context,
|
|
request gomatrixserverlib.PublicKeyLookupRequest,
|
|
key gomatrixserverlib.PublicKeyLookupResult,
|
|
) error {
|
|
return s.writer.Do(s.db, nil, func(txn *sql.Tx) error {
|
|
stmt := sqlutil.TxStmt(txn, s.upsertServerKeysStmt)
|
|
_, err := stmt.ExecContext(
|
|
ctx,
|
|
string(request.ServerName),
|
|
string(request.KeyID),
|
|
nameAndKeyID(request),
|
|
key.ValidUntilTS,
|
|
key.ExpiredTS,
|
|
key.Key.Encode(),
|
|
)
|
|
return err
|
|
})
|
|
}
|
|
|
|
func nameAndKeyID(request gomatrixserverlib.PublicKeyLookupRequest) string {
|
|
return string(request.ServerName) + "\x1F" + string(request.KeyID)
|
|
}
|