Skip to content

feat: new auth option azure-active-directory-cli #1687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jamienich wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: new auth option azure-active-directory-cli #1687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
543563b
feat: new auth option azure-active-directory-cli
Jun 18, 2025
0b6ec04
Merge pull request #1 from jamienich/connection-active-directory-cli
jamienich Jun 18, 2025
8e8791b
Merge branch 'master' into master
arthurschreiber Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"lastonesky",
"Patrik Simek <patrik@patriksimek.cz>",
"Phil Dodderidge <pdodde@poyntz.com>",
"Zach Aller"
"Zach Aller",
"Jamie Nicholson <jamie.nicholson@gmail.com>"
],
"name": "tedious",
"description": "A TDS driver, for connecting to MS SQLServer databases.",
Expand Down
27 changes: 21 additions & 6 deletions src/connection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { type SecureContextOptions } from 'tls';
import { Readable } from 'stream';

import {
AzureCliCredential,
ClientSecretCredential,
DefaultAzureCredential,
ManagedIdentityCredential,
Expand Down Expand Up @@ -236,6 +237,9 @@ interface AzureActiveDirectoryDefaultAuthentication {
};
}

interface AzureActiveDirectoryCliAuthentication {
type: 'azure-active-directory-cli';
}

interface AzureActiveDirectoryAccessTokenAuthentication {
type: 'azure-active-directory-access-token';
Expand Down Expand Up @@ -340,7 +344,7 @@ interface ErrorWithCode extends Error {
code?: string;
}

export type ConnectionAuthentication = DefaultAuthentication | NtlmAuthentication | TokenCredentialAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryAccessTokenAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication;
export type ConnectionAuthentication = DefaultAuthentication | NtlmAuthentication | TokenCredentialAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryAccessTokenAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication | AzureActiveDirectoryCliAuthentication;

interface InternalConnectionConfig {
server: string;
Expand Down Expand Up @@ -432,7 +436,8 @@ type Authentication = DefaultAuthentication |
AzureActiveDirectoryMsiVmAuthentication |
AzureActiveDirectoryAccessTokenAuthentication |
AzureActiveDirectoryServicePrincipalSecret |
AzureActiveDirectoryDefaultAuthentication;
AzureActiveDirectoryDefaultAuthentication |
AzureActiveDirectoryCliAuthentication ;

type AuthenticationType = Authentication['type'];

Expand Down Expand Up @@ -483,7 +488,7 @@ interface AuthenticationOptions {
* Type of the authentication method, valid types are `default`, `ntlm`,
* `azure-active-directory-password`, `azure-active-directory-access-token`,
* `azure-active-directory-msi-vm`, `azure-active-directory-msi-app-service`,
* `azure-active-directory-default`
* `azure-active-directory-default`, `azure-active-directory-cli`
* or `azure-active-directory-service-principal-secret`
*/
type?: AuthenticationType;
Expand All @@ -499,6 +504,7 @@ interface AuthenticationOptions {
* * `azure-active-directory-msi-app-service` : [[AzureActiveDirectoryMsiAppServiceAuthentication.options]]
* * `azure-active-directory-service-principal-secret` : [[AzureActiveDirectoryServicePrincipalSecret.options]]
* * `azure-active-directory-default` : [[AzureActiveDirectoryDefaultAuthentication.options]]
* * `azure-active-directory-cli` : [[AzureActiveDirectoryCliAuthentication.options]]
*/
options?: any;
}
Expand Down Expand Up @@ -1107,8 +1113,8 @@ class Connection extends EventEmitter {
throw new TypeError('The "config.authentication.type" property must be of type string.');
}

if (type !== 'default' && type !== 'ntlm' && type !== 'token-credential' && type !== 'azure-active-directory-password' && type !== 'azure-active-directory-access-token' && type !== 'azure-active-directory-msi-vm' && type !== 'azure-active-directory-msi-app-service' && type !== 'azure-active-directory-service-principal-secret' && type !== 'azure-active-directory-default') {
throw new TypeError('The "type" property must one of "default", "ntlm", "token-credential", "azure-active-directory-password", "azure-active-directory-access-token", "azure-active-directory-default", "azure-active-directory-msi-vm" or "azure-active-directory-msi-app-service" or "azure-active-directory-service-principal-secret".');
if (type !== 'default' && type !== 'ntlm' && type !== 'token-credential' && type !== 'azure-active-directory-password' && type !== 'azure-active-directory-access-token' && type !== 'azure-active-directory-msi-vm' && type !== 'azure-active-directory-msi-app-service' && type !== 'azure-active-directory-service-principal-secret' && type !== 'azure-active-directory-default' && type !== 'azure-active-directory-cli') {
throw new TypeError('The "type" property must one of "default", "ntlm", "token-credential", "azure-active-directory-password", "azure-active-directory-access-token", "azure-active-directory-default", "azure-active-directory-cli", "azure-active-directory-msi-vm" or "azure-active-directory-msi-app-service" or "azure-active-directory-service-principal-secret".');
}

if (typeof options !== 'object' || options === null) {
Expand Down Expand Up @@ -1205,6 +1211,10 @@ class Connection extends EventEmitter {
clientId: options.clientId
}
};
} else if (type === 'azure-active-directory-cli') {
authentication = {
type: 'azure-active-directory-cli',
};
} else if (type === 'azure-active-directory-msi-app-service') {
if (options.clientId !== undefined && typeof options.clientId !== 'string') {
throw new TypeError('The "config.authentication.options.clientId" property must be of type string.');
Expand Down Expand Up @@ -2079,6 +2089,7 @@ class Connection extends EventEmitter {
case 'azure-active-directory-msi-app-service':
case 'azure-active-directory-service-principal-secret':
case 'azure-active-directory-default':
case 'azure-active-directory-cli':
this.transitionTo(this.STATE.SENT_LOGIN7_WITH_FEDAUTH);
this.routingData = await this.performSentLogin7WithFedAuth(signal);
break;
Expand Down Expand Up @@ -2466,6 +2477,7 @@ class Connection extends EventEmitter {
case 'token-credential':
case 'azure-active-directory-msi-vm':
case 'azure-active-directory-default':
case 'azure-active-directory-cli':
case 'azure-active-directory-msi-app-service':
case 'azure-active-directory-service-principal-secret':
payload.fedAuth = {
Expand Down Expand Up @@ -3534,7 +3546,7 @@ class Connection extends EventEmitter {

if (fedAuthInfoToken && fedAuthInfoToken.stsurl && fedAuthInfoToken.spn) {
/** Federated authentication configation. */
const authentication = this.config.authentication as TokenCredentialAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication;
const authentication = this.config.authentication as TokenCredentialAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication|AzureActiveDirectoryCliAuthentication;
/** Permission scope to pass to Entra ID when requesting an authentication token. */
const tokenScope = new URL('/.default', fedAuthInfoToken.spn).toString();

Expand Down Expand Up @@ -3562,6 +3574,9 @@ class Connection extends EventEmitter {
const args = authentication.options.clientId ? { managedIdentityClientId: authentication.options.clientId } : {};
credentials = new DefaultAzureCredential(args);
break;
case 'azure-active-directory-cli':
credentials = new AzureCliCredential();
break;
case 'azure-active-directory-service-principal-secret':
credentials = new ClientSecretCredential(
authentication.options.tenantId,
Expand Down
Loading