mirror of
https://github.com/google/nomulus.git
synced 2025-05-03 13:37:51 +02:00
This follows up on Brian's work to transition not just to a new format with an empty scope value, but instead to replace the existing format entirely with a new one that: 1) includes a version number to support future format migrations 2) doesn't include a field for the scope at all, since scoping the tokens adds no real security benefit and just makes verification more difficult 3) replaces the raw SHA-256 hash with a SHA-256 HMAC instead, as a best practice to avoid length-extension attacks [1], even though in our particular case they would only be able to extend the timestamp and would thus be relatively innocuous The new format will be produced by calling generateToken(), and the scope-accepting version is renamed to generateLegacyToken() in addition to its existing deprecation, for maximum clarity. I changed the validateToken() logic to stop accepting a scope entirely; when validating a legacy-style token, we'll test it against the two existing legacy scope values ("admin" and "console") and accept it if it matches either one. Note that this means the xsrfScope parameter in @Action is now wholly obsolete; I'll remove it in a follow-up to avoid bringing extra files into this CL. After this CL hits production, the next one will replace all calls to generateLegacyToken() with generateToken(). Once that CL is deployed, the last step will be removing the legacy fallback in validateToken(). [1] See https://en.wikipedia.org/wiki/Length_extension_attack ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=148936805
149 lines
5.1 KiB
Java
149 lines
5.1 KiB
Java
// Copyright 2017 The Nomulus Authors. All Rights Reserved.
|
|
//
|
|
// 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 google.registry.security;
|
|
|
|
import static com.google.common.truth.Truth.assertThat;
|
|
import static google.registry.util.DateTimeUtils.START_OF_TIME;
|
|
import static org.junit.Assert.fail;
|
|
|
|
import com.google.appengine.api.users.User;
|
|
import com.google.common.base.Splitter;
|
|
import google.registry.testing.AppEngineRule;
|
|
import google.registry.testing.FakeClock;
|
|
import google.registry.testing.FakeUserService;
|
|
import google.registry.testing.InjectRule;
|
|
import org.joda.time.Duration;
|
|
import org.junit.Before;
|
|
import org.junit.Rule;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.mockito.runners.MockitoJUnitRunner;
|
|
|
|
/** Tests for {@link XsrfTokenManager}. */
|
|
@RunWith(MockitoJUnitRunner.class)
|
|
public class XsrfTokenManagerTest {
|
|
|
|
@Rule
|
|
public final AppEngineRule appEngine = AppEngineRule.builder()
|
|
.withDatastore()
|
|
.build();
|
|
|
|
@Rule
|
|
public InjectRule inject = new InjectRule();
|
|
|
|
private final User testUser = new User("test@example.com", "test@example.com");
|
|
private final FakeClock clock = new FakeClock(START_OF_TIME);
|
|
private final FakeUserService userService = new FakeUserService();
|
|
private final XsrfTokenManager xsrfTokenManager = new XsrfTokenManager(clock, userService);
|
|
|
|
private String token;
|
|
private String legacyToken;
|
|
|
|
@Before
|
|
public void init() {
|
|
userService.setUser(testUser, false);
|
|
token = xsrfTokenManager.generateToken(testUser.getEmail());
|
|
legacyToken = xsrfTokenManager.generateLegacyToken("console", testUser.getEmail());
|
|
}
|
|
|
|
@Test
|
|
public void testGenerateLegacyToken_invalidScope() {
|
|
try {
|
|
xsrfTokenManager.generateLegacyToken("foo", testUser.getEmail());
|
|
fail("Expected IllegalArgumentException");
|
|
} catch (IllegalArgumentException e) {
|
|
assertThat(e).hasMessageThat().isEqualTo("Invalid scope value: foo");
|
|
}
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_token() {
|
|
assertThat(xsrfTokenManager.validateToken(token)).isTrue();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_legacyToken() {
|
|
assertThat(xsrfTokenManager.validateToken(legacyToken)).isTrue();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_token_missingParts() {
|
|
assertThat(xsrfTokenManager.validateToken("foo")).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_token_badNumberTimestamp() {
|
|
assertThat(xsrfTokenManager.validateToken("1:notanumber:base64")).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_legacyToken_badNumberTimestamp() {
|
|
assertThat(xsrfTokenManager.validateToken("base64:notanumber")).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_token_expiresAfterOneDay() {
|
|
clock.advanceBy(Duration.standardDays(1));
|
|
assertThat(xsrfTokenManager.validateToken(token)).isTrue();
|
|
clock.advanceOneMilli();
|
|
assertThat(xsrfTokenManager.validateToken(token)).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_legacyToken_expiresAfterOneDay() {
|
|
clock.advanceBy(Duration.standardDays(1));
|
|
assertThat(xsrfTokenManager.validateToken(legacyToken)).isTrue();
|
|
clock.advanceOneMilli();
|
|
assertThat(xsrfTokenManager.validateToken(legacyToken)).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_token_timestampTamperedWith() {
|
|
String encodedPart = Splitter.on(':').splitToList(token).get(2);
|
|
long fakeTimestamp = clock.nowUtc().plusMillis(1).getMillis();
|
|
assertThat(xsrfTokenManager.validateToken("1:" + fakeTimestamp + ":" + encodedPart)).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_legacyToken_timestampTamperedWith() {
|
|
String encodedPart = Splitter.on(':').splitToList(legacyToken).get(0);
|
|
long tamperedTimestamp = clock.nowUtc().plusMillis(1).getMillis();
|
|
assertThat(xsrfTokenManager.validateToken(encodedPart + ":" + tamperedTimestamp)).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_token_differentUser() {
|
|
String otherToken = xsrfTokenManager.generateToken("eve@example.com");
|
|
assertThat(xsrfTokenManager.validateToken(otherToken)).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_legacyToken_differentUser() {
|
|
String otherToken = xsrfTokenManager.generateLegacyToken("console", "eve@example.com");
|
|
assertThat(xsrfTokenManager.validateToken(otherToken)).isFalse();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_legacyToken_adminScope() {
|
|
String adminToken = xsrfTokenManager.generateLegacyToken("admin", testUser.getEmail());
|
|
assertThat(xsrfTokenManager.validateToken(adminToken)).isTrue();
|
|
}
|
|
|
|
@Test
|
|
public void testValidate_legacyToken_consoleScope() {
|
|
String consoleToken = xsrfTokenManager.generateLegacyToken("console", testUser.getEmail());
|
|
assertThat(xsrfTokenManager.validateToken(consoleToken)).isTrue();
|
|
}
|
|
}
|