feat: Add configurable SSH port for source control providers and SSH … by khmish · Pull Request #1028 · vitodeploy/vito

khmish · 2026-02-11T12:19:05Z

…cloning.

feat: Add configurable SSH port for source control providers and SSH cloning.

…cloning. feat: Add configurable SSH port for source control providers and SSH cloning.

…odels and provider logic to use it.

Copilot

Pull request overview

Adds support for configuring a custom SSH port on source control connections (notably self-hosted providers) and wires that port into the SSH clone flow.

Changes:

Add port column to source_controls and expose it on the SourceControl model.
Introduce getSshPort() on source control providers and pass the port into the SSH clone script (including ssh-keyscan -p).
Add a GitLab UI field and validation rule for the SSH port.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
resources/views/ssh/git/clone.blade.php	Writes SSH config/known_hosts entries and now includes a configurable SSH port during cloning.
database/migrations/2026_02_12_074800_add_port_to_source_controls_table.php	Adds nullable `port` column to `source_controls`.
app/SourceControlProviders/SourceControlProvider.php	Extends provider interface with `getSshPort()`.
app/SourceControlProviders/Gitlab.php	Adds validation rule for a `port` input field.
app/SourceControlProviders/AbstractSourceControlProvider.php	Implements default `getSshPort()` logic for providers.
app/SSH/OS/Git.php	Passes computed SSH port into the clone view.
app/Providers/SourceControlServiceProvider.php	Adds GitLab dynamic form field for SSH port.
app/Models/SourceControl.php	Makes `port` fillable and casts it to integer.
app/Actions/SourceControl/ConnectSourceControl.php	Persists `port` when connecting a source control provider.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T13:19:17Z

app/SourceControlProviders/AbstractSourceControlProvider.php

+
+    public function getSshPort(): ?int
+    {
+        return (int) $this->sourceControl->port ?: ((int) ($this->sourceControl->provider_data['port'] ?? null) ?: null);


getSshPort() uses a nested cast/ternary that can return surprising results and doesn't enforce valid SSH port bounds. Consider normalizing with explicit null checks (prefer $this->sourceControl->port first) and returning null for out-of-range values so callers can safely default to 22.

Suggested change

return (int) $this->sourceControl->port ?: ((int) ($this->sourceControl->provider_data['port'] ?? null) ?: null);

$port = $this->sourceControl->port;

if ($port === null && isset($this->sourceControl->provider_data['port'])) {

$port = $this->sourceControl->provider_data['port'];

}

if ($port === null) {

return null;

}

$port = (int) $port;

if ($port < 1 || $port > 65535) {

return null;

}

return $port;

Copilot · 2026-02-12T13:19:18Z

resources/views/ssh/git/clone.blade.php

-        IdentityFile=~/.ssh/{{ $key }}" >> ~/.ssh/config
+Hostname {{ $host }}
+Port {{ $port }}
+IdentityFile=~/.ssh/{{ $key }}" >> ~/.ssh/config


In ~/.ssh/config, IdentityFile is normally specified as IdentityFile <path> (space-separated). Using IdentityFile=... risks being parsed as an unknown option and can make SSH ignore/fail the config, breaking cloning. Update the rendered config line to use the standard IdentityFile syntax.

Suggested change

IdentityFile=~/.ssh/{{ $key }}" >> ~/.ssh/config

IdentityFile ~/.ssh/{{ $key }}" >> ~/.ssh/config

Copilot · 2026-02-12T13:19:18Z

database/migrations/2026_02_12_074800_add_port_to_source_controls_table.php

+    public function up(): void
+    {
+        Schema::table('source_controls', function (Blueprint $table): void {
+            $table->unsignedInteger('port')->nullable()->after('url');


This migration uses unsignedInteger for an SSH port, but valid ports only range up to 65535. Using unsignedSmallInteger better models the domain and prevents accidental storage of out-of-range values.

Suggested change

$table->unsignedInteger('port')->nullable()->after('url');

$table->unsignedSmallInteger('port')->nullable()->after('url');

Copilot · 2026-02-12T13:19:19Z

app/SSH/OS/Git.php

                'path' => $path ?? $site->path,
                'branch' => $site->branch,
                'key' => $site->getSshKeyName(),
+                'port' => $site->sourceControl?->provider()?->getSshPort() ?? 22,


New behavior (passing a configurable SSH port into the clone script) isn’t covered by existing SourceControl connection tests. Consider adding a test that connects/creates a Gitlab source control with a non-22 port and asserts it’s persisted and used (or at least surfaced via getSshPort()), with defaulting to 22 when unset.

Copilot · 2026-02-12T13:19:19Z

app/SourceControlProviders/SourceControlProvider.php


    public function getRepos(bool $useCache = true): array;
-
    public function getBranches(string $repo, bool $useCache = true): array;


Adding getSshPort() to the SourceControlProvider interface is a backwards-incompatible change for any external/custom source-control providers registered via the plugin system. If this project supports third-party providers, consider providing a non-breaking default (e.g. via an optional trait/base class contract or a separate interface) or clearly documenting this as a breaking change.

Suggested change

public function getBranches(string $repo, bool $useCache = true): array;

public function getBranches(string $repo, bool $useCache = true): array;

}

interface SshAwareSourceControlProvider extends SourceControlProvider

{

Copilot · 2026-02-12T13:19:19Z

app/Actions/SourceControl/ConnectSourceControl.php

            'profile' => $input['name'],
            'url' => isset($input['url']) && $input['url'] ? $input['url'] : null,
+            'port' => isset($input['port']) && $input['port'] ? (int) $input['port'] : null,
            'project_id' => isset($input['global']) && $input['global'] ? null : $user->currentProject?->id,


port is persisted from user input but there is no base validation for it. For non-Gitlab providers, providerRules() won't include port, yet this code will still store the value (including negatives / >65535), which can later break SSH cloning. Add a shared validation rule for port (e.g. nullable|integer|min:1|max:65535) in validate() or only allow persisting it when the active provider explicitly supports it.

Copilot · 2026-02-12T13:19:19Z

app/SourceControlProviders/Gitlab.php

                'url:http,https',
                'ends_with:/',
            ],
+            'port' => 'nullable|integer',


The new port field is optional but currently lacks bounds validation. SSH ports must be within 1-65535; allowing 0/negative/large values will cause connection failures (and can store invalid data in an unsignedInteger column). Consider changing the rule to include min/max (and keep it consistent with server port validation elsewhere in the codebase).

Suggested change

'port' => 'nullable|integer',

'port' => 'nullable|integer|min:1|max:65535',

khmish added 2 commits February 11, 2026 14:55

feat: Add configurable SSH port for source control providers and SSH …

14be226

…cloning. feat: Add configurable SSH port for source control providers and SSH cloning.

feat: Add a port column to source controls table and update related m…

3127f16

…odels and provider logic to use it.

saeedvaziry requested a review from Copilot February 12, 2026 13:08

Copilot started reviewing on behalf of saeedvaziry February 12, 2026 13:09 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

feat: add method to retrieve SSH port for GitLab provider

9500f1b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add configurable SSH port for source control providers and SSH …#1028

feat: Add configurable SSH port for source control providers and SSH …#1028
khmish wants to merge 3 commits intovitodeploy:3.xfrom
khmish:custome-source-control-port

khmish commented Feb 11, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

-        return (int) $this->sourceControl->port ?: ((int) ($this->sourceControl->provider_data['port'] ?? null) ?: null);
+        $port = $this->sourceControl->port;
+        if ($port === null && isset($this->sourceControl->provider_data['port'])) {
+            $port = $this->sourceControl->provider_data['port'];
+        }
+        if ($port === null) {
+            return null;
+        }
+        $port = (int) $port;
+        if ($port < 1 || $port > 65535) {
+            return null;
+        }
+        return $port;

	IdentityFile=~/.ssh/{{ $key }}" >> ~/.ssh/config
	IdentityFile ~/.ssh/{{ $key }}" >> ~/.ssh/config

	$table->unsignedInteger('port')->nullable()->after('url');
	$table->unsignedSmallInteger('port')->nullable()->after('url');


		public function getRepos(bool $useCache = true): array;

		public function getBranches(string $repo, bool $useCache = true): array;

	'port' => 'nullable\|integer',
	'port' => 'nullable\|integer\|min:1\|max:65535',

Uh oh!

Conversation

khmish commented Feb 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant