File size: 11,850 Bytes
7b715bc | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 | /*
Copyright 2020 Google LLC
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
https://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.
*/
using Google.Apis.Auth.OAuth2;
using Google.Apis.Auth.OAuth2.Requests;
using Google.Apis.Tests.Mocks;
using System;
using System.Threading;
using System.Threading.Tasks;
using Xunit;
namespace Google.Apis.Auth.Tests.OAuth2
{
public class LocalServerCodeReceiverTests
{
private const string CallbackUriTemplateLocalhost = "http://localhost:{0}/authorize/";
private const string CallbackUriTemplate127001 = "http://127.0.0.1:{0}/authorize/";
[Fact]
public void CallbackUri_PrefersLoopback()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// All uris are good.
Func<string, bool> listenerFails = u => false;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
var uri = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplate127001, uri);
}
[Fact]
public void CallbackUri_PrefersLoopback_SecondRequest()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// All uris are good.
Func<string, bool> listenerFails = u => false;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
var uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplate127001, uri2);
}
[Fact]
public void CallbackUri_LoopbackListenerFails()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
Func<string, bool> listenerFails = u => u == CallbackUriTemplate127001;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
var uri = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplateLocalhost, uri);
}
[Fact]
public void CallbackUri_LoopbackTimesOut()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// All uris are good.
Func<string, bool> listenerFails = u => false;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
// This one should be loopback.
var uri = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
// Move the clock so that loopback times out.
clock.UtcNow = clock.UtcNow.AddMinutes(2);
var uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplateLocalhost, uri2);
}
[Fact]
public void CallbackUri_LoopbackReportedFailure()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// All uris are good.
Func<string, bool> listenerFails = u => false;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
// This one should be loopback.
var uri = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
chooser.ReportFailure(CallbackUriTemplate127001);
var uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplateLocalhost, uri2);
}
[Fact]
public void CallbackUri_LoopbackReportedSuccess()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// All uris are good.
Func<string, bool> listenerFails = u => false;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
var uri = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
chooser.ReportSuccess(CallbackUriTemplate127001);
var uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplate127001, uri2);
// Even after time out
clock.UtcNow = clock.UtcNow.AddMinutes(2);
uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplate127001, uri2);
// Even if a failure is reported, it succeeded at least once
// so the failure is transient.
chooser.ReportFailure(CallbackUriTemplate127001);
uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplate127001, uri2);
}
[Fact]
public void CallbackUri_BothFail()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// All uris are good.
Func<string, bool> listenerFails = u => false;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
// They should alternate based on the amount of reuse.
var uri1 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
chooser.ReportFailure(uri1);
var uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
chooser.ReportFailure(uri2);
var uri3 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
chooser.ReportFailure(uri3);
var uri4 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
chooser.ReportFailure(uri4);
Assert.Equal(CallbackUriTemplate127001, uri1);
Assert.Equal(CallbackUriTemplate127001, uri3);
Assert.Equal(CallbackUriTemplateLocalhost, uri2);
Assert.Equal(CallbackUriTemplateLocalhost, uri4);
}
[Fact]
public void CallbackUri_BothTimeout()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// All uris are good.
Func<string, bool> listenerFails = u => false;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
// They should alternate based on the amount of reuse.
var uri1 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
clock.UtcNow = clock.UtcNow.AddMinutes(2);
var uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
clock.UtcNow = clock.UtcNow.AddMinutes(2);
var uri3 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
clock.UtcNow = clock.UtcNow.AddMinutes(2);
var uri4 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
clock.UtcNow = clock.UtcNow.AddMinutes(2);
Assert.Equal(CallbackUriTemplate127001, uri1);
Assert.Equal(CallbackUriTemplate127001, uri3);
Assert.Equal(CallbackUriTemplateLocalhost, uri2);
Assert.Equal(CallbackUriTemplateLocalhost, uri4);
}
[Fact]
public void CallbackUri_TimeoutPreferredForRetries()
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
Func<string, bool> listenerFails = u => u == CallbackUriTemplate127001;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
// Loopback IP failed so this one is localhost.
var uri1 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
// Make localhost time out.
clock.UtcNow = clock.UtcNow.AddMinutes(2);
// This one should still be localhost, which was timed out
// vs loopback which was failed. And they have the same amount of reuses.
var uri2 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
// Make it time out again.
clock.UtcNow = clock.UtcNow.AddMinutes(2);
// And now this should be loopback, it had less reuse.
var uri3 = chooser.GetUriTemplate(LocalServerCodeReceiver.CallbackUriChooserStrategy.Default);
Assert.Equal(CallbackUriTemplateLocalhost, uri1);
Assert.Equal(CallbackUriTemplateLocalhost, uri2);
Assert.Equal(CallbackUriTemplate127001, uri3);
}
[Theory]
[InlineData(LocalServerCodeReceiver.CallbackUriChooserStrategy.ForceLoopbackIp, CallbackUriTemplate127001)]
[InlineData(LocalServerCodeReceiver.CallbackUriChooserStrategy.ForceLocalhost, CallbackUriTemplateLocalhost)]
public void CallbackUri_ForcesStrategy(LocalServerCodeReceiver.CallbackUriChooserStrategy strategy, string expectedTemplate)
{
MockClock clock = new MockClock(DateTime.UtcNow);
TimeSpan timeout = TimeSpan.FromMinutes(1);
// Make the template that should be forced, fail on the listener check.
Func<string, bool> listenerFails = u => u == expectedTemplate;
var chooser = new LocalServerCodeReceiver.CallbackUriChooser(clock, timeout, listenerFails);
var uri1 = chooser.GetUriTemplate(strategy);
// Even after time out
clock.UtcNow = clock.UtcNow.AddMinutes(2);
var uri2 = chooser.GetUriTemplate(strategy);
// Even if a failure is reported, it succeeded at least once
// so the failure is transient.
chooser.ReportFailure(expectedTemplate);
var uri3 = chooser.GetUriTemplate(strategy);
Assert.Equal(expectedTemplate, uri1);
Assert.Equal(expectedTemplate, uri2);
Assert.Equal(expectedTemplate, uri3);
}
[Fact]
public async Task OpenBrowser_ThrowsExceptionOnFailure()
{
var codeReceiver = new FailingLocalServerCodeReceiver();
var authorizationUrl = new AuthorizationCodeRequestUrl(new Uri("https://example.com/"));
await Assert.ThrowsAsync<NotSupportedException>(() =>
codeReceiver.ReceiveCodeAsync(authorizationUrl, CancellationToken.None));
}
private class FailingLocalServerCodeReceiver : LocalServerCodeReceiver
{
protected override bool OpenBrowser(string url) => false;
}
}
}
|