Rename useSSL to useTLS and useTLS to useStartTLS

Author: stevebauman

src/Auth/Guard.php

@@ -80,7 +80,7 @@ public function bind(?string $username = null, ?string $password = null): void
         // Prior to binding, we will upgrade our connectivity to TLS on our current
         // connection and ensure we are not already bound before upgrading.
         // This is to prevent subsequent upgrading on several binds.
-        if ($this->connection->isUsingTLS() && ! $this->connection->isSecure()) {
+        if ($this->connection->isUsingStartTLS() && ! $this->connection->isSecure()) {
             $this->connection->startTLS();
         }
 

src/Connection.php

@@ -148,9 +148,9 @@ public function initialize(): void
     protected function configure(): void
     {
         if ($this->configuration->get('use_tls')) {
-            $this->ldap->ssl();
+            $this->ldap->setSSL();
         } elseif ($this->configuration->get('use_starttls')) {
-            $this->ldap->tls();
+            $this->ldap->setStartTLS();
         }
 
         $this->ldap->setOptions(array_replace(

src/HandlesConnection.php

@@ -40,27 +40,27 @@ trait HandlesConnection
     /**
      * Whether the connection must be bound over TLS (ldaps:// protocol).
      */
-    protected bool $useSSL = false;
+    protected bool $useTLS = false;
 
     /**
      * Whether the connection must be bound over STARTTLS (ldap:// with upgrade).
      */
-    protected bool $useTLS = false;
+    protected bool $useStartTLS = false;
 
     /**
      * {@inheritdoc}
      */
-    public function isUsingSSL(): bool
+    public function isUsingTLS(): bool
     {
-        return $this->useSSL;
+        return $this->useTLS;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function isUsingTLS(): bool
+    public function isUsingStartTLS(): bool
     {
-        return $this->useTLS;
+        return $this->useStartTLS;
     }
 
     /**
@@ -92,25 +92,25 @@ public function isConnected(): bool
      */
     public function canChangePasswords(): bool
     {
-        return $this->isUsingSSL() || $this->isUsingTLS();
+        return $this->isUsingTLS() || $this->isUsingStartTLS();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function ssl(bool $enabled = true): static
+    public function setSSL(bool $enabled = true): static
     {
-        $this->useSSL = $enabled;
+        $this->useTLS = $enabled;
 
         return $this;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function tls(bool $enabled = true): static
+    public function setStartTLS(bool $enabled = true): static
     {
-        $this->useTLS = $enabled;
+        $this->useStartTLS = $enabled;
 
         return $this;
     }
@@ -147,7 +147,7 @@ public function getConnection(): ?Connection
     public function getProtocol(): string
     {
         return $this->protocol ?: (
-            $this->isUsingSSL()
+            $this->isUsingTLS()
                 ? LdapInterface::PROTOCOL_SSL
                 : LdapInterface::PROTOCOL
         );
@@ -168,7 +168,7 @@ protected function handleBindResponse(LdapResultResponse $response): void
     {
         $this->bound = $response->successful();
 
-        $this->secure = $this->secure ?: $this->bound && $this->isUsingSSL();
+        $this->secure = $this->secure ?: $this->bound && $this->isUsingTLS();
     }
 
     /**
@@ -233,7 +233,7 @@ protected function makeConnectionUris(array|string $hosts, string|int $port): st
         // If an attempt to connect via TLS protocol (ldaps://) is being performed,
         // and we are still using the default port, we will swap it
         // for the default TLS port, for developer convenience.
-        if ($this->isUsingSSL() && $port == LdapInterface::PORT) {
+        if ($this->isUsingTLS() && $port == LdapInterface::PORT) {
             $port = LdapInterface::PORT_SSL;
         }
 

src/LdapInterface.php

@@ -285,22 +285,22 @@ interface LdapInterface
     /**
      * Set the current connection to use TLS (ldaps:// protocol).
      */
-    public function ssl(): static;
+    public function setSSL(): static;
 
     /**
      * Determine if the current connection instance is using TLS (ldaps:// protocol).
      */
-    public function isUsingSSL(): bool;
+    public function isUsingTLS(): bool;
 
     /**
      * Set the current connection to use STARTTLS (ldap:// with upgrade).
      */
-    public function tls(): static;
+    public function setStartTLS(): static;
 
     /**
      * Determine if the current connection instance is using STARTTLS (ldap:// with upgrade).
      */
-    public function isUsingTLS(): bool;
+    public function isUsingStartTLS(): bool;
 
     /**
      * Determine if the connection is bound.

src/Testing/LdapFake.php

@@ -280,21 +280,21 @@ public function countEntries(mixed $result): int
     /**
      * {@inheritdoc}
      */
-    public function isUsingSSL(): bool
+    public function isUsingTLS(): bool
     {
         return $this->hasExpectations(__FUNCTION__)
             ? $this->resolveExpectation(__FUNCTION__)
-            : $this->useSSL;
+            : $this->useTLS;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function isUsingTLS(): bool
+    public function isUsingStartTLS(): bool
     {
         return $this->hasExpectations(__FUNCTION__)
             ? $this->resolveExpectation(__FUNCTION__)
-            : $this->useTLS;
+            : $this->useStartTLS;
     }
 
     /**

tests/Unit/Auth/GuardTest.php

@@ -251,7 +251,7 @@ public function test_starttls_is_only_upgraded_once_on_subsequent_binds()
             LdapFake::operation('bind')->once()->with('foo', 'bar')->andReturnResponse(1),
         ]);
 
-        $ldap->tls();
+        $ldap->setStartTLS();
 
         $this->assertFalse($ldap->isSecure());
 

tests/Unit/LdapTest.php

@@ -14,8 +14,8 @@ public function test_construct_defaults()
     {
         $ldap = new Ldap;
 
+        $this->assertFalse($ldap->isUsingStartTLS());
         $this->assertFalse($ldap->isUsingTLS());
-        $this->assertFalse($ldap->isUsingSSL());
         $this->assertFalse($ldap->isBound());
         $this->assertNull($ldap->getConnection());
         $this->assertEquals($ldap->getProtocol(), LdapInterface::PROTOCOL);
@@ -50,7 +50,7 @@ public function test_get_protocol_tls()
     {
         $ldap = new Ldap;
 
-        $ldap->ssl();
+        $ldap->setSSL();
 
         $this->assertEquals('ldaps://', $ldap->getProtocol());
     }
@@ -75,15 +75,15 @@ public function test_can_change_passwords()
     {
         $ldap = new Ldap;
 
-        $ldap->ssl();
+        $ldap->setSSL();
 
         $this->assertTrue($ldap->canChangePasswords());
 
-        $ldap->ssl(false);
+        $ldap->setSSL(false);
 
         $this->assertFalse($ldap->canChangePasswords());
 
-        $ldap->tls();
+        $ldap->setStartTLS();
 
         $this->assertTrue($ldap->canChangePasswords());
     }
@@ -113,7 +113,7 @@ public function test_is_secure_after_binding_with_a_tls_connection()
             LdapFake::operation('bind')->once()->andReturnResponse(),
         ]);
 
-        $ldap->ssl();
+        $ldap->setSSL();
 
         $this->assertFalse($ldap->isSecure());