| 1: | <?php |
| 2: | /* |
| 3: | * SimpleID |
| 4: | * |
| 5: | * Copyright (C) Kelvin Mo 2014-2025 |
| 6: | * |
| 7: | * This program is free software; you can redistribute it and/or |
| 8: | * modify it under the terms of the GNU General Public |
| 9: | * License as published by the Free Software Foundation; either |
| 10: | * version 2 of the License, or (at your option) any later version. |
| 11: | * |
| 12: | * This program is distributed in the hope that it will be useful, |
| 13: | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14: | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15: | * General Public License for more details. |
| 16: | * |
| 17: | * You should have received a copy of the GNU General Public |
| 18: | * License along with this program; if not, write to the Free |
| 19: | * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 20: | */ |
| 21: | |
| 22: | namespace SimpleID\Protocols\OAuth; |
| 23: | |
| 24: | /** |
| 25: | * An OAuth artefact that is a grant type, which can be used to |
| 26: | * grant access tokens. |
| 27: | * Under the base OAuth specification, these could be an authorization |
| 28: | * code or a refresh token. |
| 29: | * |
| 30: | * A reference to the grant is encoded along with the access token. |
| 31: | * This allows all access tokens associated with the grant to be revoked |
| 32: | * if the grant is found to be compromised. |
| 33: | */ |
| 34: | interface TokenGrantType { |
| 35: | /** |
| 36: | * Returns whether the grant is still valid and has not been |
| 37: | * revoked. |
| 38: | * |
| 39: | * The precise criteria for validity is determined by the implementing |
| 40: | * class. |
| 41: | * |
| 42: | * @return bool true if the grant is still valid |
| 43: | */ |
| 44: | public function isValid(); |
| 45: | |
| 46: | /** |
| 47: | * Returns a reference to the identifier of the artefact that |
| 48: | * granted the token. |
| 49: | * |
| 50: | * Normally the reference is simply a substring of the artefact's |
| 51: | * ID. |
| 52: | * |
| 53: | * @return string the reference of the grant identifier |
| 54: | */ |
| 55: | public function getGrantRef(); |
| 56: | } |
| 57: | |
| 58: | ?> |