Merge pull request #69 from thijskh/feature/deprecate-fingerprints

Add deprecation tags to classes and methods that work with certificate fingerprints.
simplesamlphp · Sep 13, 2016 · 1cea30c · 1cea30c
2 parents eeefb67 + d1680d3
commit 1cea30c
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 1 deletion.
diff --git a/src/SAML2/Certificate/Fingerprint.php b/src/SAML2/Certificate/Fingerprint.php
@@ -6,6 +6,8 @@
 
 /**
  * Simple representation of the fingerprint of a certificate
+ *
+ * @deprecated Please use full certificates instead.
  */
 class Fingerprint
 {
@@ -16,6 +18,8 @@ class Fingerprint
 
     /**
      * @param string $fingerPrint
+     *
+     * @deprecated Please use full certificates instead.
      */
     public function __construct($fingerPrint)
     {

diff --git a/src/SAML2/Certificate/FingerprintCollection.php b/src/SAML2/Certificate/FingerprintCollection.php
@@ -7,13 +7,16 @@
 
 /**
  * Simple collection object for transporting keys
+ * @deprecated Please load full certificates instead.
  */
 class FingerprintCollection extends ArrayCollection
 {
     /**
      * Add a key to the collection
      *
      * @param \SAML2\Certificate\Fingerprint $fingerprint
+     *
+     * @deprecated
      */
     public function add($fingerprint)
     {
@@ -31,6 +34,8 @@ public function add($fingerprint)
      * @param \SAML2\Certificate\Fingerprint $otherFingerprint
      *
      * @return bool
+     *
+     * @deprecated
      */
     public function contains(Fingerprint $otherFingerprint)
     {

diff --git a/src/SAML2/Certificate/FingerprintLoader.php b/src/SAML2/Certificate/FingerprintLoader.php
@@ -5,6 +5,9 @@
 use SAML2\Configuration\CertificateProvider;
 use SAML2\Exception\InvalidArgumentException;
 
+/**
+ * @deprecated Please load full certificates instead.
+ */
 class FingerprintLoader
 {
     /**
@@ -13,6 +16,8 @@ class FingerprintLoader
      * @param \SAML2\Configuration\CertificateProvider $configuration
      *
      * @return \SAML2\Certificate\FingerprintCollection
+     *
+     * @deprecated
      */
     public static function loadFromConfiguration(CertificateProvider $configuration)
     {
@@ -27,6 +32,8 @@ public static function loadFromConfiguration(CertificateProvider $configuration)
      * @param \SAML2\Configuration\CertificateProvider $configuration
      *
      * @return \SAML2\Certificate\FingerprintCollection
+     *
+     * @deprecated
      */
     public function loadFingerprints(CertificateProvider $configuration)
     {

diff --git a/src/SAML2/Certificate/X509.php b/src/SAML2/Certificate/X509.php
@@ -50,6 +50,8 @@ public function getCertificate()
 
     /**
      * @return \SAML2\Certificate\Fingerprint
+     *
+     * @deprecated Please use full certificates instead.
      */
     public function getFingerprint()
     {

diff --git a/src/SAML2/Configuration/CertificateProvider.php b/src/SAML2/Configuration/CertificateProvider.php
@@ -36,6 +36,8 @@ public function getCertificateFile();
      * fingerprint is a string containing the certificate fingerprint.
      *
      * @return null|array|\Traversable
+     *
+     * @deprecated Please use getCertifiateFile() or getCertificateData()
      */
     public function getCertificateFingerprints();
 }
diff --git a/src/SAML2/Configuration/IdentityProvider.php b/src/SAML2/Configuration/IdentityProvider.php
@@ -25,6 +25,9 @@ public function getCertificateFile()
         return $this->get('certificateFile');
     }
 
+    /**
+     * @deprecated Please use getCertifiateFile() or getCertificateData()
+     */
     public function getCertificateFingerprints()
     {
         return $this->get('certificateFingerprints');

diff --git a/src/SAML2/Configuration/ServiceProvider.php b/src/SAML2/Configuration/ServiceProvider.php
@@ -27,6 +27,9 @@ public function getCertificateFile()
         return $this->get('certificateFile');
     }
 
+    /**
+     * @deprecated Please use getCertificateData() or getCertificateFile().
+     */
     public function getCertificateFingerprints()
     {
         return $this->get('certificateFingerprints');

diff --git a/src/SAML2/Signature/FingerprintValidator.php b/src/SAML2/Signature/FingerprintValidator.php
@@ -10,6 +10,8 @@
 
 /**
  * Validates the signature based on the fingerprint of the certificate
+ *
+ * @deprecated Please use full certificates instead.
  */
 class FingerprintValidator extends AbstractChainedValidator
 {
@@ -23,6 +25,9 @@ class FingerprintValidator extends AbstractChainedValidator
      */
     private $fingerprintLoader;
 
+    /**
+     * @deprecated Please use full certificates instead.
+     */
     public function __construct(
         LoggerInterface $logger,
         FingerprintLoader $fingerprintLoader

diff --git a/src/SAML2/SignedElementHelper.php b/src/SAML2/SignedElementHelper.php
@@ -175,7 +175,7 @@ public function getValidatingCertificates()
         $ret = array();
         foreach ($this->certificates as $cert) {
 
-            /* We have found a matching fingerprint. */
+            /* Construct a PEM formatted certificate */
             $pemCert = "-----BEGIN CERTIFICATE-----\n" .
                 chunk_split($cert, 64) .
                 "-----END CERTIFICATE-----\n";
-Original file line number
+Diff line change
@@ Expand Up / @@ -50,6 +50,8 @@ public function getCertificate() @@
         /**
          * @return \SAML2\Certificate\Fingerprint
+         *
+         * @deprecated Please use full certificates instead.
          */
         public function getFingerprint()
         {
@@ Expand Down @@