mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-02 12:22:15 +00:00
# Which Problems Are Solved The `/.well-known/apple-app-site-association` and `/.well-known/assetlinks.json` responses are instance specific: the body depends on the requested host. The responses did not declare this, so a shared cache whose cache key does not include the host could store one instance's file and serve it on another instance's domain. This could result in a wrong or empty file being returned intermittently, breaking native passkey verification. Dropping the `public` directive (#12634) was not sufficient: depending on its cache mode, a shared cache may store any response carrying a `max-age`. The docs page for native app links also still documented the old `Cache-Control: public` header and only the single `get_login_creds` relation (missing `handle_all_urls`, added in #12634). # How the Problems Are Solved - Send **`Vary: Host`** on both well-known responses, declaring that the body depends on the host: a spec-compliant shared cache must store per-host variants or skip caching. Clients addressing a single host (the Apple and Google verifiers, browsers) are unaffected and keep honoring the configured `max-age`. - Correct the outdated caching reasoning in the code comments. - Guard the header with unit and integration tests. - Update the native app links docs page: both Digital Asset Links relations and the current response headers. # Additional Changes None. `WellKnown.AppLinksCacheControlMaxAge` behavior is unchanged (`0` still results in `no-store`). # Additional Context - Follow-up to #12634; relates to #12497. - Verified with interleaved requests against two instances: responses are no longer reused across domains, and each domain consistently serves its own configuration. - To be cherry-picked to `v4.x` from `main` once merged. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Fable 5 <[email protected]>
218 lines
6.0 KiB
Go
218 lines
6.0 KiB
Go
package well_known
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
http_util "github.com/zitadel/zitadel/internal/api/http"
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
)
|
|
|
|
func TestBuildAppleAppSiteAssociation(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tt := []struct {
|
|
name string
|
|
configs []*query.OIDCAppLinkConfig
|
|
wantApps []string
|
|
}{
|
|
{
|
|
name: "empty",
|
|
configs: nil,
|
|
wantApps: []string{},
|
|
},
|
|
{
|
|
name: "skips incomplete ios",
|
|
configs: []*query.OIDCAppLinkConfig{
|
|
{IOSTeamID: "TEAM"},
|
|
{IOSBundleID: "com.example"},
|
|
},
|
|
wantApps: []string{},
|
|
},
|
|
{
|
|
name: "aggregates and dedupes",
|
|
configs: []*query.OIDCAppLinkConfig{
|
|
{IOSTeamID: "TEAM1", IOSBundleID: "com.one"},
|
|
{IOSTeamID: "TEAM2", IOSBundleID: "com.two"},
|
|
{IOSTeamID: "TEAM1", IOSBundleID: "com.one"},
|
|
{AndroidPackageName: "com.android", AndroidSHA256CertFingerprints: []string{"AA"}},
|
|
},
|
|
wantApps: []string{"TEAM1.com.one", "TEAM2.com.two"},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tt {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
got := buildAppleAppSiteAssociation(tc.configs)
|
|
assert.Equal(t, tc.wantApps, got.WebCredentials.Apps)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestBuildAssetLinks(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tt := []struct {
|
|
name string
|
|
configs []*query.OIDCAppLinkConfig
|
|
want []assetLink
|
|
}{
|
|
{
|
|
name: "empty",
|
|
configs: nil,
|
|
want: []assetLink{},
|
|
},
|
|
{
|
|
name: "skips incomplete android",
|
|
configs: []*query.OIDCAppLinkConfig{
|
|
{AndroidPackageName: "com.example"},
|
|
{AndroidSHA256CertFingerprints: []string{"AA"}},
|
|
},
|
|
want: []assetLink{},
|
|
},
|
|
{
|
|
name: "aggregates and normalizes fingerprints",
|
|
configs: []*query.OIDCAppLinkConfig{
|
|
{
|
|
IOSTeamID: "TEAM",
|
|
IOSBundleID: "com.ios",
|
|
AndroidPackageName: "com.one",
|
|
AndroidSHA256CertFingerprints: []string{"aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899"},
|
|
},
|
|
{
|
|
AndroidPackageName: "com.two",
|
|
AndroidSHA256CertFingerprints: []string{
|
|
"cc:dd:ee:ff:00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33:44:55:66:77:88:99:aa:bb",
|
|
"eeff00112233445566778899aabbccddeeff00112233445566778899aabbccdd",
|
|
},
|
|
},
|
|
},
|
|
want: []assetLink{
|
|
{
|
|
Relation: []string{"delegate_permission/common.handle_all_urls", "delegate_permission/common.get_login_creds"},
|
|
Target: assetLinkTarget{
|
|
Namespace: "android_app",
|
|
PackageName: "com.one",
|
|
SHA256CertFingerprints: []string{
|
|
"AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Relation: []string{"delegate_permission/common.handle_all_urls", "delegate_permission/common.get_login_creds"},
|
|
Target: assetLinkTarget{
|
|
Namespace: "android_app",
|
|
PackageName: "com.two",
|
|
SHA256CertFingerprints: []string{
|
|
"CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB",
|
|
"EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tt {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
assert.Equal(t, tc.want, buildAssetLinks(t.Context(), tc.configs))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNormalizeSHA256Fingerprint(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tt := []struct {
|
|
name string
|
|
in string
|
|
want string
|
|
}{
|
|
{
|
|
name: "already canonical",
|
|
in: "AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99",
|
|
want: "AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99",
|
|
},
|
|
{
|
|
name: "lowercase with colons",
|
|
in: "aa:bb:cc:dd:ee:ff:00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33:44:55:66:77:88:99",
|
|
want: "AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99",
|
|
},
|
|
{
|
|
name: "lowercase without separators",
|
|
in: "aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899",
|
|
want: "AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99",
|
|
},
|
|
{
|
|
name: "invalid continuous hex uppercased",
|
|
in: "aabb",
|
|
want: "AABB",
|
|
},
|
|
{
|
|
name: "colon form uppercased without reparse",
|
|
in: "aa:bb",
|
|
want: "AA:BB",
|
|
},
|
|
}
|
|
|
|
for _, tc := range tt {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
assert.Equal(t, tc.want, normalizeSHA256Fingerprint(t.Context(), tc.in))
|
|
})
|
|
}
|
|
}
|
|
|
|
type stubAppLinkQuerier struct {
|
|
configs []*query.OIDCAppLinkConfig
|
|
err error
|
|
}
|
|
|
|
func (s stubAppLinkQuerier) SearchOIDCAppLinkConfigs(_ context.Context) ([]*query.OIDCAppLinkConfig, error) {
|
|
return s.configs, s.err
|
|
}
|
|
|
|
func TestHandlerCacheControl(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
h := NewHandler(stubAppLinkQuerier{})
|
|
for _, path := range []string{AppleAppSiteAssociationPath, AssetLinksPath} {
|
|
t.Run(path, func(t *testing.T) {
|
|
t.Parallel()
|
|
req := httptest.NewRequest(http.MethodGet, path, nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ServeHTTP(rec, req)
|
|
require.Equal(t, http.StatusOK, rec.Code)
|
|
// The bodies are instance specific, so HTTP caching must be disabled:
|
|
// a shared cache whose key does not cover the instance selector would
|
|
// serve one instance's file on another instance's domain.
|
|
assert.Equal(t, "no-store", rec.Header().Get(http_util.CacheControl))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestHandlerHeadOmitsBody(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
h := NewHandler(stubAppLinkQuerier{})
|
|
for _, path := range []string{AppleAppSiteAssociationPath, AssetLinksPath} {
|
|
t.Run(path, func(t *testing.T) {
|
|
t.Parallel()
|
|
req := httptest.NewRequest(http.MethodHead, path, nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ServeHTTP(rec, req)
|
|
require.Equal(t, http.StatusOK, rec.Code)
|
|
assert.Equal(t, "application/json", rec.Header().Get("Content-Type"))
|
|
assert.Equal(t, "no-store", rec.Header().Get(http_util.CacheControl))
|
|
assert.Empty(t, rec.Body.Bytes())
|
|
})
|
|
}
|
|
}
|