Skip to content

feat: add support for wildcard on SNIs for SSL #12668

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 16, 2025
Merged

feat: add support for wildcard on SNIs for SSL #12668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d58bc66
feat: add support for wildcard on SNIs for SSL
Revolyssup Oct 13, 2025
2591308
f
Revolyssup Oct 13, 2025
51b294c
add test
Revolyssup Oct 14, 2025
5485fae
fix lint
Revolyssup Oct 14, 2025
bc67323
add more tests
Revolyssup Oct 14, 2025
2ac6d23
f
Revolyssup Oct 14, 2025
7f42da0
Update radixtree_sni.lua
Revolyssup Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apisix/schema_def.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ local id_schema = {
}
}

local host_def_pat = "^\\*?[0-9a-zA-Z-._\\[\\]:]+$"
local host_def_pat = "^\\*$|^\\*?[0-9a-zA-Z-._\\[\\]:]+$"
local host_def = {
type = "string",
pattern = host_def_pat,
Expand Down
5 changes: 4 additions & 1 deletion apisix/ssl/router/radixtree_sni.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,10 @@ function _M.match_and_set(api_ctx, match_only, alt_sni)
end


if type(api_ctx.matched_sni) == "table" then
if api_ctx.matched_sni == "*" then
-- wildcard matches everything, no need for further validation
core.log.info("matched wildcard SSL for SNI: ", sni)
elseif type(api_ctx.matched_sni) == "table" then
local matched = false
for _, msni in ipairs(api_ctx.matched_sni) do
if sni_rev == msni or not str_find(sni_rev, ".", #msni) then
Expand Down
285 changes: 285 additions & 0 deletions t/stream-node/sni.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,3 +339,288 @@ proxy request to 127.0.0.3:1995
}
--- request
GET /t



=== TEST 14: set SSL with wildcard * SNI and test route matching
--- config
location /t {
content_by_lua_block {
local core = require("apisix.core")
local t = require("lib.test_admin")

local ssl_cert = t.read_file("t/certs/apisix.crt")
local ssl_key = t.read_file("t/certs/apisix.key")

-- Create SSL with wildcard * SNI (catch-all)
local data = {
cert = ssl_cert,
key = ssl_key,
sni = "*", -- Wildcard catch-all
}

local code, body = t.test('/apisix/admin/ssls/100',
ngx.HTTP_PUT,
core.json.encode(data)
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create wildcard SSL: ", code, " ", body)
return
end

-- Create a stream route that will use the wildcard SSL
local code, body = t.test('/apisix/admin/stream_routes/100',
ngx.HTTP_PUT,
[[{
"sni": "unknown-domain.com",
"upstream": {
"nodes": {
"127.0.0.1:1995": 1
},
"type": "roundrobin"
}
}]]
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create stream route: ", code, " ", body)
return
end

ngx.say("passed")
}
}
--- request
GET /t
--- response_body
passed



=== TEST 15: hit route with unknown domain using wildcard SSL
--- stream_tls_request
mmm
--- stream_sni: unknown-domain.com
--- response_body
hello world
--- error_log
proxy request to 127.0.0.1:1995



=== TEST 16: test SSL priority - exact match over partial wildcard
--- config
location /t {
content_by_lua_block {
local core = require("apisix.core")
local t = require("lib.test_admin")

local ssl_cert = t.read_file("t/certs/apisix.crt")
local ssl_key = t.read_file("t/certs/apisix.key")

-- Create SSL with exact domain match
local data = {
cert = ssl_cert,
key = ssl_key,
sni = "specific.api7.dev",
}

local code, body = t.test('/apisix/admin/ssls/101',
ngx.HTTP_PUT,
core.json.encode(data)
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create exact SSL: ", code, " ", body)
return
end

-- Create SSL with partial wildcard
local data = {
cert = ssl_cert,
key = ssl_key,
sni = "*.api7.dev",
}

local code, body = t.test('/apisix/admin/ssls/102',
ngx.HTTP_PUT,
core.json.encode(data)
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create partial wildcard SSL: ", code, " ", body)
return
end

-- Create routes for testing
local code, body = t.test('/apisix/admin/stream_routes/101',
ngx.HTTP_PUT,
[[{
"sni": "specific.api7.dev",
"upstream": {
"nodes": {
"127.0.0.1:1995": 1
},
"type": "roundrobin"
}
}]]
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create exact route: ", code, " ", body)
return
end

local code, body = t.test('/apisix/admin/stream_routes/102',
ngx.HTTP_PUT,
[[{
"sni": "*.api7.dev",
"upstream": {
"nodes": {
"127.0.0.2:1995": 1
},
"type": "roundrobin"
}
}]]
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create partial wildcard route: ", code, " ", body)
return
end

ngx.say("passed")
}
}
--- request
GET /t
--- response_body
passed



=== TEST 17: verify exact domain takes priority over partial wildcard
--- stream_tls_request
mmm
--- stream_sni: specific.api7.dev
--- response_body
hello world
--- error_log
proxy request to 127.0.0.1:1995
--- no_error_log
proxy request to 127.0.0.2:1995



=== TEST 18: test SSL priority - partial match over wildcard
--- config
location /t {
content_by_lua_block {
local core = require("apisix.core")
local t = require("lib.test_admin")

local ssl_cert = t.read_file("t/certs/apisix.crt")
local ssl_key = t.read_file("t/certs/apisix.key")

-- Create SSL with partial domain match
local data = {
cert = ssl_cert,
key = ssl_key,
sni = "specific.api7.dev",
}

local code, body = t.test('/apisix/admin/ssls/101',
ngx.HTTP_PUT,
core.json.encode(data)
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create exact SSL: ", code, " ", body)
return
end

-- Create SSL with wildcard
local data = {
cert = ssl_cert,
key = ssl_key,
sni = "*",
}

local code, body = t.test('/apisix/admin/ssls/102',
ngx.HTTP_PUT,
core.json.encode(data)
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create partial wildcard SSL: ", code, " ", body)
return
end

-- Create routes for testing
local code, body = t.test('/apisix/admin/stream_routes/101',
ngx.HTTP_PUT,
[[{
"sni": "*.api7.dev",
"upstream": {
"nodes": {
"127.0.0.1:1995": 1
},
"type": "roundrobin"
}
}]]
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create exact route: ", code, " ", body)
return
end

local code, body = t.test('/apisix/admin/stream_routes/102',
ngx.HTTP_PUT,
[[{
"sni": "*",
"upstream": {
"nodes": {
"127.0.0.2:1995": 1
},
"type": "roundrobin"
}
}]]
)

if code >= 300 then
ngx.status = code
ngx.say("failed to create partial wildcard route: ", code, " ", body)
return
end

ngx.say("passed")
}
}
--- request
GET /t
--- response_body
passed



=== TEST 19: verify partial match takes priority over wildcard
--- stream_tls_request
mmm
--- stream_sni: specific.api7.dev
--- response_body
hello world
--- error_log
proxy request to 127.0.0.1:1995
--- no_error_log
proxy request to 127.0.0.2:1995
Loading