├── .gitignore ├── LICENSE ├── README.md ├── composer.json └── src └── Uecode └── Bundle └── ApiKeyBundle ├── DependencyInjection ├── Configuration.php ├── Security │ └── Factory │ │ └── ApiKeyFactory.php └── UecodeApiKeyExtension.php ├── Document └── ApiKeyUser.php ├── Entity └── ApiKeyUser.php ├── Extractor ├── HeaderExtractor.php ├── KeyExtractor.php └── QueryExtractor.php ├── Model └── ApiKeyUser.php ├── Resources └── config │ └── services.yml ├── Security ├── Authentication │ ├── Provider │ │ ├── ApiKeyProvider.php │ │ ├── ApiKeyUserProviderInterface.php │ │ ├── EmailUserProvider.php │ │ └── UserProvider.php │ └── Token │ │ └── ApiKeyUserToken.php └── Firewall │ └── ApiKeyListener.php ├── UecodeApiKeyBundle.php └── Util ├── ApiKeyGenerator.php └── ApiKeyGeneratorInterface.php /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor 2 | /composer.lock -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ApiKey Bundle 2 | ============= 3 | 4 | Creates an avenue for using ApiKey authentication for Symfony2. Requires FOSUserBundle. 5 | 6 | # Installation 7 | 8 | Requires composer, install as follows 9 | 10 | ```sh 11 | composer require uecode/api-key-bundle dev-master 12 | ``` 13 | 14 | ## Enable Bundle 15 | 16 | Place in your `AppKernel.php` to enable the bundle 17 | 18 | ```php 19 | userManager->findUserBy(array('apiKey' => $apiKey)); 92 | } 93 | 94 | } 95 | ``` 96 | 97 | ## Change security settings 98 | 99 | You can now add `api_key: true`, and `stateless: true` to any of your firewalls. 100 | 101 | For Example: 102 | 103 | ```yml 104 | security: 105 | firewalls: 106 | auth: 107 | pattern: ^/api/* 108 | api_key: true 109 | stateless: true 110 | provider: db # Required if you have multiple providers and firewalls 111 | 112 | ``` 113 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "uecode/api-key-bundle", 3 | "description": "Creates an avenue for using ApiKey authentication for Symfony2. Requires FOSUserBundle.", 4 | "license": "Apache 2.0", 5 | "require": { 6 | "php": "^5.3|^7.0", 7 | "symfony/symfony": "^2.3|^3.0", 8 | "friendsofsymfony/user-bundle": "^1|~2.0@dev" 9 | }, 10 | "autoload": { 11 | "psr-0": { 12 | "Uecode\\Bundle\\ApiKeyBundle": "src/" 13 | } 14 | }, 15 | "authors": [ 16 | { 17 | "name": "Aaron Scherer", 18 | "email": "aequasi@gmail.com" 19 | } 20 | ] 21 | } 22 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/DependencyInjection/Configuration.php: -------------------------------------------------------------------------------- 1 | root('uecode_api_key'); 17 | 18 | $rootNode 19 | ->children() 20 | ->scalarNode('delivery') 21 | ->defaultValue('query') 22 | ->validate() 23 | ->ifNotInArray(array('query', 'header')) 24 | ->thenInvalid('Unknown authentication delivery type "%s".') 25 | ->end() 26 | ->end() 27 | ->scalarNode('parameter_name') 28 | ->defaultValue('api_key') 29 | ->end() 30 | ->end() 31 | ; 32 | 33 | return $treeBuilder; 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/DependencyInjection/Security/Factory/ApiKeyFactory.php: -------------------------------------------------------------------------------- 1 | 13 | */ 14 | class ApiKeyFactory implements SecurityFactoryInterface 15 | { 16 | public function create(ContainerBuilder $container, $id, $config, $userProvider, $defaultEntryPoint) 17 | { 18 | $providerId = 'security.authentication.provider.api_key.' . $id; 19 | $container->setDefinition($providerId, new DefinitionDecorator('uecode.api_key.provider.api_key')) 20 | ->replaceArgument(0, new Reference($userProvider)); 21 | 22 | $listenerId = 'security.authentication.listener.api_key.' . $id; 23 | $listener = $container->setDefinition($listenerId, new DefinitionDecorator('uecode.api_key.listener.api_key')); 24 | 25 | return array($providerId, $listenerId, $defaultEntryPoint); 26 | } 27 | 28 | public function getPosition() 29 | { 30 | return 'pre_auth'; 31 | } 32 | 33 | public function getKey() 34 | { 35 | return 'api_key'; 36 | } 37 | 38 | public function addConfiguration(NodeDefinition $builder) 39 | { 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/DependencyInjection/UecodeApiKeyExtension.php: -------------------------------------------------------------------------------- 1 | 12 | */ 13 | class UecodeApiKeyExtension extends Extension 14 | { 15 | public function load(array $configs, ContainerBuilder $container) 16 | { 17 | $configuration = new Configuration(); 18 | $config = $this->processConfiguration($configuration, $configs); 19 | 20 | $loader = new Loader\YamlFileLoader( 21 | $container, 22 | new FileLocator(__DIR__.'/../Resources/config') 23 | ); 24 | $loader->load('services.yml'); 25 | 26 | $this->defineKeyExtractor($config, $container); 27 | } 28 | 29 | private function defineKeyExtractor(array $config, ContainerBuilder $container) 30 | { 31 | $container->setParameter('uecode.api_key.parameter_name', $config['parameter_name']); 32 | $container->setAlias('uecode.api_key.extractor', 'uecode.api_key.extractor.'.$config['delivery']); 33 | } 34 | } 35 | 36 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Document/ApiKeyUser.php: -------------------------------------------------------------------------------- 1 | 11 | */ 12 | class HeaderExtractor implements KeyExtractor 13 | { 14 | private $parameterName; 15 | 16 | /** 17 | * @param string $parameterName The name of the URL parameter containing the API key. 18 | */ 19 | public function __construct($parameterName) 20 | { 21 | $this->parameterName = $parameterName; 22 | } 23 | 24 | /** 25 | * {@inheritDoc} 26 | */ 27 | public function hasKey(Request $request) 28 | { 29 | return $request->headers->has($this->parameterName); 30 | } 31 | 32 | /** 33 | * {@inheritDoc} 34 | */ 35 | public function extractKey(Request $request) 36 | { 37 | return $request->headers->get($this->parameterName); 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Extractor/KeyExtractor.php: -------------------------------------------------------------------------------- 1 | 9 | */ 10 | interface KeyExtractor 11 | { 12 | /** 13 | * Tells if the given requests carries an API key. 14 | * 15 | * @param Request $request 16 | * 17 | * @return bool 18 | */ 19 | function hasKey(Request $request); 20 | 21 | /** 22 | * Extract the API key from thhe given request 23 | * 24 | * @param Request $request 25 | * 26 | * @return string 27 | */ 28 | function extractKey(Request $request); 29 | } 30 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Extractor/QueryExtractor.php: -------------------------------------------------------------------------------- 1 | 11 | */ 12 | class QueryExtractor implements KeyExtractor 13 | { 14 | private $parameterName; 15 | 16 | /** 17 | * @param string $parameterName The name of the URL parameter containing the API key. 18 | */ 19 | public function __construct($parameterName) 20 | { 21 | $this->parameterName = $parameterName; 22 | } 23 | 24 | /** 25 | * {@inheritDoc} 26 | */ 27 | public function hasKey(Request $request) 28 | { 29 | return $request->query->has($this->parameterName); 30 | } 31 | 32 | /** 33 | * {@inheritDoc} 34 | */ 35 | public function extractKey(Request $request) 36 | { 37 | return $request->query->get($this->parameterName); 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Model/ApiKeyUser.php: -------------------------------------------------------------------------------- 1 | setApiKey(ApiKeyGenerator::generate()); 19 | } 20 | 21 | /** 22 | * @param string $apiKey 23 | */ 24 | public function setApiKey($apiKey) 25 | { 26 | $this->apiKey = $apiKey; 27 | } 28 | 29 | /** 30 | * @return string 31 | */ 32 | public function getApiKey() 33 | { 34 | return $this->apiKey; 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Resources/config/services.yml: -------------------------------------------------------------------------------- 1 | parameters: 2 | uecode.api_key.provider.user_provider.class: Uecode\Bundle\ApiKeyBundle\Security\Authentication\Provider\UserProvider 3 | uecode.api_key.provider.email_user_provider.class: Uecode\Bundle\ApiKeyBundle\Security\Authentication\Provider\EmailUserProvider 4 | uecode.api_key.provider.api_key.class: Uecode\Bundle\ApiKeyBundle\Security\Authentication\Provider\ApiKeyProvider 5 | uecode.api_key.listener.api_key.class: Uecode\Bundle\ApiKeyBundle\Security\Firewall\ApiKeyListener 6 | 7 | uecode.api_key.extractor.query.class: Uecode\Bundle\ApiKeyBundle\Extractor\QueryExtractor 8 | uecode.api_key.extractor.header.class: Uecode\Bundle\ApiKeyBundle\Extractor\HeaderExtractor 9 | 10 | uecode.api_key.generator.class: Uecode\Bundle\ApiKeyBundle\Util\ApiKeyGenerator 11 | 12 | services: 13 | uecode.api_key.provider.user_provider: 14 | class: %uecode.api_key.provider.user_provider.class% 15 | arguments: ["@fos_user.user_manager"] 16 | uecode.api_key.provider.email_user_provider: 17 | class: %uecode.api_key.provider.email_user_provider.class% 18 | arguments: ["@fos_user.user_manager"] 19 | uecode.api_key.provider.api_key: 20 | class: %uecode.api_key.provider.api_key.class% 21 | arguments: [""] 22 | uecode.api_key.listener.api_key: 23 | class: %uecode.api_key.listener.api_key.class% 24 | arguments: ["@security.token_storage", "@security.authentication.manager", "@uecode.api_key.extractor"] 25 | 26 | uecode.api_key.extractor.query: 27 | class: %uecode.api_key.extractor.query.class% 28 | arguments: [%uecode.api_key.parameter_name%] 29 | public: false 30 | uecode.api_key.extractor.header: 31 | class: %uecode.api_key.extractor.header.class% 32 | arguments: [%uecode.api_key.parameter_name%] 33 | public: false 34 | uecode.api_key.generator: 35 | class: %uecode.api_key.generator.class% 36 | public: false -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Security/Authentication/Provider/ApiKeyProvider.php: -------------------------------------------------------------------------------- 1 | 16 | */ 17 | class ApiKeyProvider implements AuthenticationProviderInterface 18 | { 19 | /** 20 | * @var UserProviderInterface 21 | */ 22 | protected $userProvider; 23 | 24 | public function __construct(UserProviderInterface $userProvider) 25 | { 26 | $this->userProvider = $userProvider; 27 | } 28 | 29 | /** 30 | * Attempts to authenticate a TokenInterface object. 31 | * 32 | * @param TokenInterface $token The TokenInterface instance to authenticate 33 | * 34 | * @return TokenInterface An authenticated TokenInterface instance, never null 35 | * 36 | * @throws AuthenticationException if the authentication fails 37 | */ 38 | public function authenticate(TokenInterface $token) 39 | { 40 | if($this->userProvider instanceof ChainUserProvider) { 41 | foreach ($this->userProvider->getProviders() as $provider) { 42 | $result = $this->doAuth($provider, $token); 43 | if($result !== false) { 44 | return $result; 45 | } 46 | } 47 | } else { 48 | $result = $this->doAuth($this->userProvider, $token); 49 | if ($result !== false) { 50 | return $result; 51 | } 52 | } 53 | } 54 | 55 | /** 56 | * @param UserProviderInterface $provider 57 | * @param TokenInterface $token 58 | * 59 | * @return bool|ApiKeyUserToken 60 | * @throws AuthenticationException 61 | */ 62 | protected function doAuth($provider, TokenInterface $token) 63 | { 64 | if (! $provider instanceof ApiKeyUserProviderInterface) { 65 | return false; 66 | } 67 | 68 | /** @var UserInterface $user */ 69 | $user = $provider->loadUserByApiKey($token->getCredentials()); 70 | 71 | if ($user) { 72 | $authenticatedToken = new ApiKeyUserToken($user->getRoles()); 73 | $authenticatedToken->setUser($user); 74 | 75 | return $authenticatedToken; 76 | } 77 | 78 | throw new AuthenticationException("The API Key authentication failed."); 79 | } 80 | 81 | /** 82 | * Checks whether this provider supports the given token. 83 | * 84 | * @param TokenInterface $token A TokenInterface instance 85 | * 86 | * @return Boolean true if the implementation supports the Token, false otherwise 87 | */ 88 | public function supports(TokenInterface $token) 89 | { 90 | return $token instanceof ApiKeyUserToken; 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Security/Authentication/Provider/ApiKeyUserProviderInterface.php: -------------------------------------------------------------------------------- 1 | 6 | */ 7 | interface ApiKeyUserProviderInterface 8 | { 9 | /** 10 | * @param string $apiKey 11 | * 12 | * @return UserInterface 13 | */ 14 | public function loadUserByApiKey($apiKey); 15 | } 16 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Security/Authentication/Provider/EmailUserProvider.php: -------------------------------------------------------------------------------- 1 | 10 | */ 11 | class EmailUserProvider extends FOSUserProvider implements ApiKeyUserProviderInterface 12 | { 13 | /** 14 | * @var bool Stateless Authentication? 15 | */ 16 | private $stateless = false; 17 | 18 | /** 19 | * {@inheritdoc} 20 | */ 21 | public function loadUserByApiKey($apiKey) 22 | { 23 | $this->stateless = true; 24 | 25 | return $this->userManager->findUserBy(array('apiKey' => $apiKey)); 26 | } 27 | 28 | /** 29 | * @param SecurityUserInterface $user 30 | * 31 | * @return SecurityUserInterface 32 | * @throws UnsupportedUserException 33 | */ 34 | public function refreshUser(SecurityUserInterface $user) 35 | { 36 | if ($this->stateless) { 37 | throw new UnsupportedUserException(); 38 | } 39 | return parent::refreshUser($user); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Security/Authentication/Provider/UserProvider.php: -------------------------------------------------------------------------------- 1 | 10 | */ 11 | class UserProvider extends FOSUserProvider implements ApiKeyUserProviderInterface 12 | { 13 | /** 14 | * @var bool Stateless Authentication? 15 | */ 16 | private $stateless = false; 17 | 18 | /** 19 | * {@inheritdoc} 20 | */ 21 | public function loadUserByApiKey($apiKey) 22 | { 23 | $this->stateless = true; 24 | 25 | return $this->userManager->findUserBy(array('apiKey' => $apiKey)); 26 | } 27 | 28 | /** 29 | * @param SecurityUserInterface $user 30 | * 31 | * @return SecurityUserInterface 32 | * @throws UnsupportedUserException 33 | */ 34 | public function refreshUser(SecurityUserInterface $user) 35 | { 36 | if ($this->stateless) { 37 | throw new UnsupportedUserException(); 38 | } 39 | return parent::refreshUser($user); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Security/Authentication/Token/ApiKeyUserToken.php: -------------------------------------------------------------------------------- 1 | 9 | */ 10 | class ApiKeyUserToken extends AbstractToken 11 | { 12 | /** 13 | * @var string 14 | */ 15 | protected $apiKey; 16 | 17 | public function __construct(array $roles = array()) 18 | { 19 | parent::__construct($roles); 20 | 21 | $this->setAuthenticated(sizeof($roles) > 0); 22 | } 23 | 24 | /** 25 | * Returns the user credentials. 26 | * 27 | * @return mixed The user credentials 28 | */ 29 | public function getCredentials() 30 | { 31 | return $this->apiKey; 32 | } 33 | 34 | /** 35 | * @param string $apiKey 36 | */ 37 | public function setApiKey($apiKey) 38 | { 39 | $this->apiKey = $apiKey; 40 | } 41 | 42 | /** 43 | * @return string 44 | */ 45 | public function getApiKey() 46 | { 47 | return $this->apiKey; 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Security/Firewall/ApiKeyListener.php: -------------------------------------------------------------------------------- 1 | 16 | */ 17 | class ApiKeyListener implements ListenerInterface 18 | { 19 | /** 20 | * @var TokenStorageInterface 21 | */ 22 | private $tokenStorage; 23 | 24 | /** 25 | * @var AuthenticationManagerInterface 26 | */ 27 | private $authenticationManager; 28 | 29 | /** 30 | * @var KeyExtractor 31 | */ 32 | private $keyExtractor; 33 | 34 | public function __construct(TokenStorageInterface $tokenStorage, AuthenticationManagerInterface $manager, KeyExtractor $keyExtractor) 35 | { 36 | $this->tokenStorage = $tokenStorage; 37 | $this->authenticationManager = $manager; 38 | $this->keyExtractor = $keyExtractor; 39 | } 40 | 41 | /** 42 | * This interface must be implemented by firewall listeners. 43 | * 44 | * @param GetResponseEvent $event 45 | */ 46 | public function handle(GetResponseEvent $event) 47 | { 48 | $request = $event->getRequest(); 49 | 50 | if (!$this->keyExtractor->hasKey($request)) { 51 | $response = new Response(); 52 | $response->setStatusCode(401); 53 | $event->setResponse($response); 54 | return ; 55 | } 56 | 57 | $apiKey = $this->keyExtractor->extractKey($request); 58 | 59 | $token = new ApiKeyUserToken(); 60 | $token->setApiKey($apiKey); 61 | 62 | try { 63 | $authToken = $this->authenticationManager->authenticate($token); 64 | $this->tokenStorage->setToken($authToken); 65 | 66 | return; 67 | } catch (AuthenticationException $failed) { 68 | $token = $this->tokenStorage->getToken(); 69 | if ($token instanceof ApiKeyUserToken && $token->getCredentials() == $apiKey) { 70 | $this->tokenStorage->setToken(null); 71 | } 72 | 73 | $message = $failed->getMessage(); 74 | } 75 | 76 | $response = new Response(); 77 | $response->setContent($message); 78 | $response->setStatusCode(403); 79 | $event->setResponse($response); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/UecodeApiKeyBundle.php: -------------------------------------------------------------------------------- 1 | 12 | */ 13 | class UecodeApiKeyBundle extends Bundle 14 | { 15 | public function build(ContainerBuilder $container) 16 | { 17 | parent::build($container); 18 | 19 | /** @var SecurityExtension $extension */ 20 | $extension = $container->getExtension('security'); 21 | $extension->addSecurityListenerFactory(new ApiKeyFactory()); 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Util/ApiKeyGenerator.php: -------------------------------------------------------------------------------- 1 | 7 | */ 8 | class ApiKeyGenerator implements ApiKeyGeneratorInterface 9 | { 10 | private $characterSet = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; 11 | private $apiKeyLength = 64; 12 | 13 | public function generateApiKey() 14 | { 15 | return self::generate($this->characterSet, $this->apiKeyLength); 16 | } 17 | 18 | public static function generate($characterSet = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', $apiKeyLength = 64) 19 | { 20 | $characterSetLength = strlen($characterSet); 21 | 22 | $apikey = ''; 23 | for ($i = 0; $i < $apiKeyLength; ++$i) { 24 | $apikey .= $characterSet[rand(0, $characterSetLength - 1)]; 25 | } 26 | 27 | return rtrim(base64_encode(sha1(uniqid('ue' . rand(rand(), rand())) . $apikey)), '='); 28 | } 29 | } -------------------------------------------------------------------------------- /src/Uecode/Bundle/ApiKeyBundle/Util/ApiKeyGeneratorInterface.php: -------------------------------------------------------------------------------- 1 | 7 | */ 8 | interface ApiKeyGeneratorInterface 9 | { 10 | public function generateApiKey(); 11 | } --------------------------------------------------------------------------------