fix(ssh): rename magickey's function due typo

Author: henrybarreto

ssh/pkg/magickey/magickey.go

@@ -1,3 +1,4 @@
+// Package magickey provides RSA key generation for ShellHub SSH service.
 package magickey
 
 import (
@@ -8,9 +9,9 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-// GetRerefence gets a reference for a [*rsa.PrivateKey] used on ShellHub's SSH service. This reference is generate once
-// and them used on every subsequence call.
-var GetRerefence = sync.OnceValue(func() *rsa.PrivateKey {
+// GetReference returns a singleton RSA private key for ShellHub SSH service.
+// The key is generated once and reused across all subsequent calls.
+var GetReference = sync.OnceValue(func() *rsa.PrivateKey {
 	key, err := rsa.GenerateKey(rand.Reader, 2048)
 	if err != nil {
 		log.WithError(err).Fatal()

ssh/pkg/magickey/magickey_test.go

@@ -0,0 +1,87 @@
+package magickey
+
+import (
+	"crypto/rsa"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetReference(t *testing.T) {
+	tests := []struct {
+		name string
+		test func(t *testing.T)
+	}{
+		{
+			name: "success when called twice returns singleton key",
+			test: func(t *testing.T) {
+				key1 := GetReference()
+				key2 := GetReference()
+				assert.Same(t, key1, key2)
+			},
+		},
+		{
+			name: "success when key is valid RSA 2048",
+			test: func(t *testing.T) {
+				key := GetReference()
+				assert.NotNil(t, key)
+				assert.Equal(t, 2048, key.N.BitLen())
+				assert.NotNil(t, key.PublicKey)
+				assert.Equal(t, 2048, key.PublicKey.N.BitLen())
+			},
+		},
+		{
+			name: "success when key is usable for operations",
+			test: func(t *testing.T) {
+				key := GetReference()
+				assert.NotNil(t, key.Primes)
+				assert.Len(t, key.Primes, 2)
+				assert.NotNil(t, key.Precomputed)
+			},
+		},
+		{
+			name: "success when multiple calls return same key",
+			test: func(t *testing.T) {
+				keys := make([]*rsa.PrivateKey, 10)
+				for i := 0; i < 10; i++ {
+					keys[i] = GetReference()
+				}
+				firstKey := keys[0]
+				for _, key := range keys {
+					assert.Same(t, firstKey, key)
+				}
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, tc.test)
+	}
+}
+
+func TestGetReference_Concurrency(t *testing.T) {
+	t.Run("success when called concurrently returns singleton", func(t *testing.T) {
+		const numGoroutines = 100
+		keys := make(chan *rsa.PrivateKey, numGoroutines)
+		for i := 0; i < numGoroutines; i++ {
+			go func() {
+				keys <- GetReference()
+			}()
+		}
+		collectedKeys := make([]*rsa.PrivateKey, numGoroutines)
+		for i := 0; i < numGoroutines; i++ {
+			collectedKeys[i] = <-keys
+		}
+		firstKey := collectedKeys[0]
+		for _, key := range collectedKeys {
+			assert.Same(t, firstKey, key)
+		}
+	})
+}
+
+func BenchmarkGetReference(b *testing.B) {
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_ = GetReference()
+	}
+}

ssh/session/auther.go

@@ -96,7 +96,7 @@ func (p *publicKeyAuth) Evaluate(session *Session) error {
 
 	fingerprint := gossh.FingerprintLegacyMD5(p.pk)
 
-	magic, err := gossh.NewPublicKey(&magickey.GetRerefence().PublicKey)
+	magic, err := gossh.NewPublicKey(&magickey.GetReference().PublicKey)
 	if err != nil {
 		return err
 	}

ssh/web/pkg/token/token.go

@@ -25,7 +25,7 @@ func NewToken(_ *rsa.PrivateKey) (*Token, error) {
 
 	token, err := jwt.NewWithClaims(jwt.SigningMethodRS256, jwt.MapClaims{
 		"id": identifier,
-	}).SignedString(magickey.GetRerefence())
+	}).SignedString(magickey.GetReference())
 	if err != nil {
 		return nil, err
 	}
@@ -41,7 +41,7 @@ func Parse(token string) (*Token, error) {
 			return nil, fmt.Errorf("unexpected method: %s", jwtToken.Header["alg"])
 		}
 
-		return magickey.GetRerefence().Public().(*rsa.PublicKey), nil
+		return magickey.GetReference().Public().(*rsa.PublicKey), nil
 	}); err != nil {
 		return nil, err
 	}

ssh/web/web.go

@@ -47,7 +47,7 @@ func NewSSHServerBridge(router *echo.Echo, cache cache.Cache) {
 				return
 			}
 
-			key := magickey.GetRerefence()
+			key := magickey.GetReference()
 
 			token, err := token.NewToken(key)
 			if err != nil {
@@ -111,7 +111,7 @@ func NewSSHServerBridge(router *echo.Echo, cache cache.Cache) {
 
 		go conn.KeepAlive()
 
-		creds.decryptPassword(magickey.GetRerefence()) //nolint:errcheck
+		creds.decryptPassword(magickey.GetReference()) //nolint:errcheck
 
 		if err := newSession(
 			wsconn.Request().Context(),