Make getGoogleAuthenticatorUsername and getTotpAuthenticationUsername nullable, #293

No need to return an empty string, can return null to have a record without label in the TOTP app

Author: scheb

doc/providers/google.rst

@@ -76,7 +76,7 @@ Authenticator for a user, generate a secret code and persist it with the user en
                return null !== $this->googleAuthenticatorSecret;
            }
 
-           public function getGoogleAuthenticatorUsername(): string
+           public function getGoogleAuthenticatorUsername(): ?string
            {
                return $this->username;
            }
@@ -114,7 +114,7 @@ Authenticator for a user, generate a secret code and persist it with the user en
                return null !== $this->googleAuthenticatorSecret;
            }
 
-           public function getGoogleAuthenticatorUsername(): string
+           public function getGoogleAuthenticatorUsername(): ?string
            {
                return $this->username;
            }

src/google-authenticator/Model/Google/TwoFactorInterface.php

@@ -14,7 +14,7 @@ public function isGoogleAuthenticatorEnabled(): bool;
     /**
      * Return the user name. This is used in QR code generation to display the username in the TOTP app.
      */
-    public function getGoogleAuthenticatorUsername(): string;
+    public function getGoogleAuthenticatorUsername(): string|null;
 
     /**
      * Return the Google Authenticator secret

src/google-authenticator/Security/TwoFactor/Provider/Google/GoogleTotpFactory.php

@@ -34,12 +34,14 @@ public function createTotpForUser(TwoFactorInterface $user): TOTPInterface
         /** @psalm-suppress ArgumentTypeCoercion */
         $totp = TOTP::create($secret, 30, 'sha1', $this->digits, clock: $this->clock);
 
-        $userAndHost = $user->getGoogleAuthenticatorUsername().(null !== $this->server && $this->server ? '@'.$this->server : '');
+        $usernameLabel = $user->getGoogleAuthenticatorUsername() ?? '';
+        $serverLabel = $this->server ?? '';
+        $userAndHost = $usernameLabel.(strlen($serverLabel) > 0 && strlen($usernameLabel) > 0 ? '@' : '').$serverLabel;
         if ('' !== $userAndHost) {
             $totp->setLabel($userAndHost);
         }
 
-        if (null !== $this->issuer && $this->issuer) {
+        if (null !== $this->issuer && '' !== $this->issuer) {
             $totp->setIssuer($this->issuer);
         }
 

src/totp/Model/Totp/TwoFactorInterface.php

@@ -15,7 +15,7 @@ public function isTotpAuthenticationEnabled(): bool;
      * Return the user name. This is used in QR code generation to display the username in the TOTP app. Return an
      * empty string, if you don't want it to show up in the app.
      */
-    public function getTotpAuthenticationUsername(): string;
+    public function getTotpAuthenticationUsername(): string|null;
 
     /**
      * Return the configuration for TOTP authentication.

src/totp/Security/TwoFactor/Provider/Totp/TotpFactory.php

@@ -48,12 +48,14 @@ public function createTotpForUser(TwoFactorInterface $user): TOTPInterface
             clock: $this->clock,
         );
 
-        $userAndHost = $user->getTotpAuthenticationUsername().(null !== $this->server && $this->server ? '@'.$this->server : '');
+        $usernameLabel = $user->getTotpAuthenticationUsername() ?? '';
+        $serverLabel = $this->server ?? '';
+        $userAndHost = $usernameLabel.(strlen($serverLabel) > 0 && strlen($usernameLabel) > 0 ? '@' : '').$serverLabel;
         if ('' !== $userAndHost) {
             $totp->setLabel($userAndHost);
         }
 
-        if (null !== $this->issuer && $this->issuer) {
+        if (null !== $this->issuer && '' !== $this->issuer) {
             $totp->setIssuer($this->issuer);
         }