Files
SimpleRemoter/server/2015Remote/BuiltinTlsCert.h
T
yuanyuanxianganddeepseek-flash c4021e1fc9 Feature: Ship a built-in TLS certificate so encryption works out of the box
A fresh install used to require openssl before the server could speak TLS:
two empty paths in [tls] meant the identity failed to load and every
ClientHello was refused. TLS is now on by default and, when no custom
certificate is configured, the server generates its own self-signed one the
first time it needs it -- RSA-2048, SHA-256, CN=yama-server, CA:TRUE, valid
for ten years from one day before now. Plaintext clients are untouched, since
the device port still splits plaintext from TLS by sniffing the first six
bytes of a connection.

The certificate and its PKCS#8 private key are stored side by side in the
config under [tls] BuiltinCert / BuiltinKey as single-line base64 DER. Single
line, because the server has two config backends -- the registry for Release,
settings.ini for a Debug master -- and only a line without newlines means the
same read/write code serves both. That in turn required fixing the registry
reader: iniFile::GetStr copied into a 512 byte stack buffer, so a 1.5 KB value
came back as a truncated or empty string. The two-phase dynamic read now lives
in common/iniFile.h as ReadRegistryValueSz / ReadRegistrySz, and the copy that
client/TlsChannel.cpp had been carrying for its own trust anchor is gone. This
also makes the built-in certificate self-checking: Ensure() re-reads what it
just wrote and fails loudly if the round trip did not survive.

Import has to go through NCRYPT_PKCS8_PRIVATE_KEY_BLOB, matching the import
path in BuildIdentityFromDer. NCRYPT_PKCS8_PRIV_KEY_INFO_BLOB, which most
samples reach for, is not implemented by the Microsoft Software KSP and
returns NTE_INVALID_PARAMETER; a probe confirmed it, and the export type that
works is the one the importer already expected. Building an identity is now
split into a file front-end (PEM, fullchain, PKCS#1 hints) and a shared DER
core, so the built-in and file paths cannot drift apart.

That key also exposed a second problem worth fixing here. The identity binds
its private key to the certificate by name -- CRYPT_KEY_PROV_INFO with
pwszContainerName -- and Schannel resolves that name on every handshake
through CryptAcquireCertificatePrivateKey. With the fixed name
"YamaServerTlsKey", two server processes under the same Windows user shared
one key slot: whichever loaded last overwrote it, and the other process's next
handshake picked up a private key that does not match its certificate. That is
exactly the debug-plus-release pairing used here, and defaulting to a built-in
certificate is what makes it reachable, since the debug instance no longer
points at the same PEM as the release instance. The name is now the base name
plus the first six bytes of the certificate's SHA-1 thumbprint, e.g.
YamaServerTlsKey-c0d469eae8a4: different certificates get different keys,
instances sharing one certificate still share one key. MCP picks this up too.
The effective name goes to the trace log so a collision is visible without a
debugger. A stale key from an older build may still sit in the key store under
the old name; nothing references it and it is not deleted automatically, since
a running instance of an older build could be using it.

The trust anchor still has to be pushed. The client pins exactly one root
through an exclusive-root chain engine and checks no host name, so a
self-signed CA:TRUE leaf chains cleanly to itself -- but only if the client is
told about it. That is the existing 启用 TLS / 切换到 WSS command, which now
takes the PEM from ServerTlsIdentity::AnchorPem instead of re-reading the
configured cert file, so it reports the same certificate the server actually
serves for both sources. Losing the stored certificate (cleared registry, new
Windows user) regenerates it, and every client must be re-pushed the anchor.

Two places that used to fall back to [tls] CertPath now skip that fallback
while the built-in certificate is active: the MCP HTTPS front end at startup
and the prefill in its settings dialog. A self-signed certificate cannot pass
validation at a public MCP client, and the retained CertPath is only a
leftover from switching back to a custom certificate, so pretending to use it
would fail later with a worse message. MCP HTTPS with empty paths already
fails closed with a log line.

The TLS dialog gains a 内置证书 checkbox, ticked by default and unticked when
certificate paths are present; ticking it greys out the path rows without
clearing them, and shows either "generated on first use" or the expiry date
read back from the stored certificate. Saving writes four keys -- Enabled,
UseBuiltIn, CertPath, KeyPath -- and an explicit UseBuiltIn keeps the paths
from being used as an implicit switch. Every reader of [tls] Enabled now
defaults to 1, so the menu check, the dialog and the loader agree on a fresh
install. The status bar panes on 无 / 有 grew a third state, 内置, and the
pane width is measured across all three.

Translations were added to en_US, zh_TW and de_DE; skipping the German file
would have left the new dialog text in Chinese there, as de_DE is loaded from
disk rather than embedded.

Verified with the debug server against openssl s_client. Both the generated
built-in certificate (CN=yama-server) and an existing custom one
(CN=localhost) complete a TLS 1.2 handshake with the pinned certificate, and
their log lines show distinct key names, c0d469eae8a4 and 272f2adfb19c. An
unmodified client still runs in plaintext without an anchor, an existing custom
certificate deployment behaves exactly as before, and client and server both
build clean at Debug x64.

Co-Authored-By: deepseek-flash
2026-11-01 15:39:54 +01:00

45 lines
2.2 KiB
C++
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
#pragma once
#include <Windows.h>
#include <string>
#include <vector>
class config;
// 内置 TLS 证书
//
// 目的:让服务端 TLS「开箱即用」——全新部署不再需要 openssl 手工生成证书/私钥,
// 首次启用加密时自动生成一张自签证书(RSA-2048 / SHA-256 / CN=yama-server /
// BasicConstraints CA:TRUE / 有效期 10 年)。
//
// 存储:证书与私钥以【单行 base64(DER)】写进服务端配置的 [tls] 节(BuiltinCert /
// BuiltinKey)。单行是因为服务端配置有两种后端:Release 走注册表
// (HKCU\Software\YAMA),Debug 的 master 实例走 settings.ini——INI 的值不能含换行,
// 存成单行两种后端都能用同一套读写代码(长值读取见 common/iniFile.h 的
// ReadRegistryValueSz / iniFile::GetStr)。
//
// 信任锚:客户端严格 pin 服务端证书(见 client/TlsChannel.cpp 的 VerifyServerCert),
// 所以内置证书无法「自动被信任」——仍由既有「启用 TLS」下发指令把本证书的 PEM 推给
// 客户端(ServerTlsIdentity::AnchorPem)。证书丢失(注册表被清、换 Windows 用户)会
// 重新生成一张新的,已下发的客户端必须重新下发信任锚。
namespace BuiltinTlsCert
{
// 是否使用内置证书:显式键 [tls] UseBuiltIn 优先;未设置时按「有自定义证书路径即用
// 自定义、否则用内置」推导(对应「用户已设置证书路径和私钥则不勾选内置证书」)。
bool UseBuiltin(config& cfg);
// 确保配置里有一对可解析的内置证书/私钥;缺失或损坏时生成并写回。
// 首次调用要生成 RSA-2048 并自签,约几百毫秒。失败返回 false(调用方对 TLS 握手
// fail-closed)。
bool Ensure(config& cfg);
// 读取已存的内置证书/私钥(解码为 DER)。任一缺失或损坏返回 false。
bool ReadDer(config& cfg, std::vector<BYTE>& certDer, std::vector<BYTE>& keyDer);
// 内置证书的 PEM 文本(下发客户端信任锚用)。未生成时返回空串。
std::string CertPem(config& cfg);
// 对话框展示用:证书到期日 "2036-11-01"。未生成/无法解析时返回空串。
std::string Describe(config& cfg);
}