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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
|
<?php
declare(strict_types=1);
namespace SimpleSAML\Test\Utils\Config;
use DOMDocument;
use InvalidArgumentException;
use PHPUnit\Framework\TestCase;
use SAML2\Constants;
use SimpleSAML\Utils\Config\Metadata;
use TypeError;
/**
* Tests related to SAML metadata.
*/
class MetadataTest extends TestCase
{
/**
* Test contact configuration parsing and sanitizing.
* @return void
*/
public function testGetContact(): void
{
// test invalid argument
try {
/** @psalm-suppress InvalidArgument May be removed in 2.0 when codebase is fully typehinted */
Metadata::getContact('string');
} catch (\InvalidArgumentException $e) {
$this->assertEquals('Invalid input parameters', $e->getMessage());
}
// test missing type
$contact = [
'name' => 'John Doe'
];
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertStringStartsWith('"contactType" is mandatory and must be one of ', $e->getMessage());
}
// test invalid type
$contact = [
'contactType' => 'invalid'
];
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertStringStartsWith('"contactType" is mandatory and must be one of ', $e->getMessage());
}
// test all valid contact types
foreach (Metadata::$VALID_CONTACT_TYPES as $type) {
$contact = [
'contactType' => $type
];
$parsed = Metadata::getContact($contact);
$this->assertArrayHasKey('contactType', $parsed);
$this->assertArrayNotHasKey('givenName', $parsed);
$this->assertArrayNotHasKey('surName', $parsed);
}
// test basic name parsing
$contact = [
'contactType' => 'technical',
'name' => 'John Doe'
];
$parsed = Metadata::getContact($contact);
$this->assertArrayNotHasKey('name', $parsed);
$this->assertArrayHasKey('givenName', $parsed);
$this->assertArrayHasKey('surName', $parsed);
$this->assertEquals('John', $parsed['givenName']);
$this->assertEquals('Doe', $parsed['surName']);
// test comma-separated names
$contact = [
'contactType' => 'technical',
'name' => 'Doe, John'
];
$parsed = Metadata::getContact($contact);
$this->assertArrayHasKey('givenName', $parsed);
$this->assertArrayHasKey('surName', $parsed);
$this->assertEquals('John', $parsed['givenName']);
$this->assertEquals('Doe', $parsed['surName']);
// test long names
$contact = [
'contactType' => 'technical',
'name' => 'John Fitzgerald Doe Smith'
];
$parsed = Metadata::getContact($contact);
$this->assertArrayNotHasKey('name', $parsed);
$this->assertArrayHasKey('givenName', $parsed);
$this->assertArrayNotHasKey('surName', $parsed);
$this->assertEquals('John Fitzgerald Doe Smith', $parsed['givenName']);
// test comma-separated long names
$contact = [
'contactType' => 'technical',
'name' => 'Doe Smith, John Fitzgerald'
];
$parsed = Metadata::getContact($contact);
$this->assertArrayNotHasKey('name', $parsed);
$this->assertArrayHasKey('givenName', $parsed);
$this->assertArrayHasKey('surName', $parsed);
$this->assertEquals('John Fitzgerald', $parsed['givenName']);
$this->assertEquals('Doe Smith', $parsed['surName']);
// test givenName
$contact = [
'contactType' => 'technical',
];
$invalid_types = [0, [0], 0.1, true, false];
foreach ($invalid_types as $type) {
$contact['givenName'] = $type;
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertEquals('"givenName" must be a string and cannot be empty.', $e->getMessage());
}
}
// test surName
$contact = [
'contactType' => 'technical',
];
$invalid_types = [0, [0], 0.1, true, false];
foreach ($invalid_types as $type) {
$contact['surName'] = $type;
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertEquals('"surName" must be a string and cannot be empty.', $e->getMessage());
}
}
// test company
$contact = [
'contactType' => 'technical',
];
$invalid_types = [0, [0], 0.1, true, false];
foreach ($invalid_types as $type) {
$contact['company'] = $type;
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertEquals('"company" must be a string and cannot be empty.', $e->getMessage());
}
}
// test emailAddress
$contact = [
'contactType' => 'technical',
];
$invalid_types = [0, 0.1, true, false, []];
foreach ($invalid_types as $type) {
$contact['emailAddress'] = $type;
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertEquals(
'"emailAddress" must be a string or an array and cannot be empty.',
$e->getMessage()
);
}
}
$invalid_types = [["string", true], ["string", 0]];
foreach ($invalid_types as $type) {
$contact['emailAddress'] = $type;
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertEquals(
'Email addresses must be a string and cannot be empty.',
$e->getMessage()
);
}
}
$valid_types = ['email@example.com', ['email1@example.com', 'email2@example.com']];
foreach ($valid_types as $type) {
$contact['emailAddress'] = $type;
$parsed = Metadata::getContact($contact);
$this->assertEquals($type, $parsed['emailAddress']);
}
// test telephoneNumber
$contact = [
'contactType' => 'technical',
];
$invalid_types = [0, 0.1, true, false, []];
foreach ($invalid_types as $type) {
$contact['telephoneNumber'] = $type;
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertEquals(
'"telephoneNumber" must be a string or an array and cannot be empty.',
$e->getMessage()
);
}
}
$invalid_types = [["string", true], ["string", 0]];
foreach ($invalid_types as $type) {
$contact['telephoneNumber'] = $type;
try {
Metadata::getContact($contact);
} catch (InvalidArgumentException $e) {
$this->assertEquals('Telephone numbers must be a string and cannot be empty.', $e->getMessage());
}
}
$valid_types = ['1234', ['1234', '5678']];
foreach ($valid_types as $type) {
$contact['telephoneNumber'] = $type;
$parsed = Metadata::getContact($contact);
$this->assertEquals($type, $parsed['telephoneNumber']);
}
// test completeness
$contact = [];
foreach (Metadata::$VALID_CONTACT_OPTIONS as $option) {
$contact[$option] = 'string';
}
$contact['contactType'] = 'technical';
$contact['name'] = 'to_be_removed';
$contact['attributes'] = ['test' => 'testval'];
$parsed = Metadata::getContact($contact);
foreach (array_keys($parsed) as $key) {
$this->assertEquals($parsed[$key], $contact[$key]);
}
$this->assertArrayNotHasKey('name', $parsed);
}
/**
* Test \SimpleSAML\Utils\Config\Metadata::isHiddenFromDiscovery().
* @return void
*/
public function testIsHiddenFromDiscovery(): void
{
// test for success
$metadata = [
'EntityAttributes' => [
Metadata::$ENTITY_CATEGORY => [
Metadata::$HIDE_FROM_DISCOVERY,
],
],
];
$this->assertTrue(Metadata::isHiddenFromDiscovery($metadata));
// test for failure
$this->assertFalse(Metadata::isHiddenFromDiscovery([
'EntityAttributes' => [
Metadata::$ENTITY_CATEGORY => [],
],
]));
// test for failures
$this->expectException(TypeError::class);
Metadata::isHiddenFromDiscovery(['foo']);
$this->assertFalse(Metadata::isHiddenFromDiscovery([
'EntityAttributes' => 'bar',
]));
$this->assertFalse(Metadata::isHiddenFromDiscovery([
'EntityAttributes' => [],
]));
$this->assertFalse(Metadata::isHiddenFromDiscovery([
'EntityAttributes' => [
Metadata::$ENTITY_CATEGORY => '',
],
]));
}
/**
* Test \SimpleSAML\Utils\Config\Metadata::parseNameIdPolicy().
* @return void
*/
public function testParseNameIdPolicy(): void
{
// Test null or unset
$nameIdPolicy = null;
$this->assertEquals(
['Format' => Constants::NAMEID_TRANSIENT, 'AllowCreate' => true],
Metadata::parseNameIdPolicy($nameIdPolicy)
);
// Test false
$nameIdPolicy = false;
$this->assertEquals(null, Metadata::parseNameIdPolicy($nameIdPolicy));
// Test string
$nameIdPolicy = 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress';
$this->assertEquals(
['Format' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', 'AllowCreate' => true],
Metadata::parseNameIdPolicy($nameIdPolicy)
);
// Test array
$nameIdPolicy = [
'Format' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:persistent',
'AllowCreate' => false
];
$this->assertEquals([
'Format' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:persistent',
'AllowCreate' => false
], Metadata::parseNameIdPolicy($nameIdPolicy));
$nameIdPolicy = [
'Format' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:persistent',
'AllowCreate' => false,
'SPNameQualifier' => 'TEST'
];
$this->assertEquals([
'Format' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:persistent',
'AllowCreate' => false,
'SPNameQualifier' => 'TEST'
], Metadata::parseNameIdPolicy($nameIdPolicy));
}
}
|