Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Authentication v2 #100

Merged
merged 19 commits into from
Jan 20, 2016
Merged

Authentication v2 #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
d48be2d
Login with Authorization header instead of cookies
Jan 8, 2016
48b99d9
Round trip to server to validate access keys on login/registration
Jan 8, 2016
2d307e4
Remove SDK logout() command as the server no longer maintains sessions
Jan 12, 2016
25db3c4
Remove 'access token' concept from SDK, and refactoring
Jan 12, 2016
ff3317a
Remove 'login' concept from sdk
Jan 12, 2016
ebe8d1c
Fix bug with parsing access token
Jan 12, 2016
9d9ee4a
Tidy promise rejection pattern
Jan 12, 2016
2ec497c
Refactoring. Also check for whether we're already logged in before re…
Jan 12, 2016
ac90734
Remove global 'connectionInfo' object
Jan 12, 2016
70080f6
Remove publicly exposed properties from the SDK
Jan 12, 2016
c9f7383
Supply default user-agent in SDK
Jan 12, 2016
4635095
Send desired API version using 'Accept' header
Jan 12, 2016
062d0f8
Tidy up error handling mechanism
Jan 12, 2016
2507efb
Tidying
Jan 12, 2016
b4bf500
Fix unit tests
Jan 12, 2016
e1cad8e
Trim trailing whitespace
Jan 12, 2016
aa28dd6
Tidy up SDK variable names to avoid confusion
Jan 12, 2016
4e3d713
Code tidying based on feedback
Jan 14, 2016
444d458
SDK - Move account-manager.ts into the root directory
Jan 19, 2016
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
2 changes: 1 addition & 1 deletion cli/definitions/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface IAccessKeyListCommand extends ICommand {
}

export interface IAccessKeyRemoveCommand extends ICommand {
accessKeyName: string;
accessKey: string;
}

export interface IAppAddCommand extends ICommand {
Expand Down
209 changes: 94 additions & 115 deletions cli/script/command-executor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ var progress = require("progress");
var configFilePath: string = path.join(process.env.LOCALAPPDATA || process.env.HOME, ".code-push.config");
var userAgent: string = packageJson.name + "/" + packageJson.version;
Copy link
Member

@dtivel dtivel Jan 14, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could remove this since AccountManager sets this value by default.

Copy link
Contributor Author

@richardhuaaa richardhuaaa Jan 14, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sets the user-agent to be code-push-cli/<CLI-version>, whereas the default SDK user agent is code-push/<SDK-version>. I think it's useful to distinguish the CLI as a distinct user agent, especially when the SDK will be consumed externally. But, I can also see the simplicity benefit of having user-agent strings being defined only by the SDK version, so feel free to discuss if you think that should be the case!


interface IStandardLoginConnectionInfo {
interface ILegacyLoginConnectionInfo {
accessKeyName: string;
providerName: string;
providerUniqueId: string;
serverUrl: string;
}

interface IAccessKeyLoginConnectionInfo {
interface ILoginConnectionInfo {
accessKey: string;
serverUrl: string;
}
Expand All @@ -47,31 +47,6 @@ interface IPackageFile {
export var sdk: AccountManager;
export var log = (message: string | Chalk.ChalkChain): void => console.log(message);

export var loginWithAccessToken = (): Promise<void> => {
if (!connectionInfo) {
return Q.fcall(() => { throw new Error("You are not currently logged in. Run the 'code-push login' command to authenticate with the CodePush server."); });
}

sdk = new AccountManager(connectionInfo.serverUrl, userAgent);

var accessToken: string;

var standardLoginConnectionInfo: IStandardLoginConnectionInfo = <IStandardLoginConnectionInfo>connectionInfo;
var accessKeyLoginConnectionInfo: IAccessKeyLoginConnectionInfo = <IAccessKeyLoginConnectionInfo>connectionInfo;

if (standardLoginConnectionInfo.providerName) {
accessToken = base64.encode(JSON.stringify({
accessKeyName: standardLoginConnectionInfo.accessKeyName,
providerName: standardLoginConnectionInfo.providerName,
providerUniqueId: standardLoginConnectionInfo.providerUniqueId
}));
} else {
accessToken = accessKeyLoginConnectionInfo.accessKey;
}

return sdk.loginWithAccessToken(accessToken);
}

export var confirm = (): Promise<boolean> => {
return Promise<boolean>((resolve, reject, notify): void => {
prompt.message = "";
Expand All @@ -96,8 +71,6 @@ export var confirm = (): Promise<boolean> => {
});
}

var connectionInfo: IStandardLoginConnectionInfo|IAccessKeyLoginConnectionInfo;

function accessKeyAdd(command: cli.IAccessKeyAddCommand): Promise<void> {
var hostname: string = os.hostname();
return sdk.addAccessKey(hostname, command.description)
Expand All @@ -115,24 +88,20 @@ function accessKeyList(command: cli.IAccessKeyListCommand): Promise<void> {
});
}

function removeLocalAccessKey(): Promise<void> {
return Q.fcall(() => { throw new Error("Cannot remove the access key for the current session. Please run 'code-push logout' if you would like to remove this access key."); });
}

function accessKeyRemove(command: cli.IAccessKeyRemoveCommand): Promise<void> {
if (connectionInfo && (command.accessKeyName === (<IStandardLoginConnectionInfo>connectionInfo).accessKeyName || command.accessKeyName === (<IAccessKeyLoginConnectionInfo>connectionInfo).accessKey)) {
return removeLocalAccessKey();
if (command.accessKey === sdk.accessKey) {
throw new Error("Cannot remove the access key for the current session. Please run 'code-push logout' if you would like to remove this access key.");
} else {
return getAccessKeyId(command.accessKeyName)
return getAccessKeyId(command.accessKey)
.then((accessKeyId: string): Promise<void> => {
throwForInvalidAccessKeyId(accessKeyId, command.accessKeyName);
throwForInvalidAccessKeyId(accessKeyId, command.accessKey);

return confirm()
.then((wasConfirmed: boolean): Promise<void> => {
if (wasConfirmed) {
return sdk.removeAccessKey(accessKeyId)
.then((): void => {
log("Successfully removed the \"" + command.accessKeyName + "\" access key.");
log("Successfully removed the \"" + command.accessKey + "\" access key.");
});
}

Expand Down Expand Up @@ -325,7 +294,7 @@ function deploymentHistory(command: cli.IDeploymentHistoryCommand): Promise<void
});
}

function deserializeConnectionInfo(): IStandardLoginConnectionInfo|IAccessKeyLoginConnectionInfo {
function deserializeConnectionInfo(): ILegacyLoginConnectionInfo|ILoginConnectionInfo {
var savedConnection: string;

try {
Expand All @@ -334,34 +303,35 @@ function deserializeConnectionInfo(): IStandardLoginConnectionInfo|IAccessKeyLog
return;
}

var credentialsObject: IStandardLoginConnectionInfo|IAccessKeyLoginConnectionInfo = tryJSON(savedConnection);
return credentialsObject;
}

function notifyAlreadyLoggedIn(): Promise<void> {
return Q.fcall(() => { throw new Error("You are already logged in from this machine."); });
var connectionInfo: ILegacyLoginConnectionInfo|ILoginConnectionInfo = tryJSON(savedConnection);
return connectionInfo;
}

export function execute(command: cli.ICommand): Promise<void> {
connectionInfo = deserializeConnectionInfo();
var connectionInfo: ILegacyLoginConnectionInfo|ILoginConnectionInfo = deserializeConnectionInfo();

switch (command.type) {
case cli.CommandType.login:
if (connectionInfo) {
return notifyAlreadyLoggedIn();
}
return Q(<void>null)
.then(() => {
switch (command.type) {
case cli.CommandType.login:
case cli.CommandType.register:
if (connectionInfo) {
throw new Error("You are already logged in from this machine.");
}
break;

return login(<cli.ILoginCommand>command);
default:
if (!!sdk) break; // Used by unit tests to skip authentication

case cli.CommandType.logout:
return logout(<cli.ILogoutCommand>command);
if (!connectionInfo) {
throw new Error("You are not currently logged in. Run the 'code-push login' command to authenticate with the CodePush server.");
}

case cli.CommandType.register:
return register(<cli.IRegisterCommand>command);
}
var accessKey: string = getAccessKeyFromConnectionInfo(connectionInfo);
sdk = new AccountManager(accessKey, userAgent, connectionInfo.serverUrl);
break;
}

return loginWithAccessToken()
.then((): Promise<void> => {
switch (command.type) {
case cli.CommandType.accessKeyAdd:
return accessKeyAdd(<cli.IAccessKeyAddCommand>command);
Expand Down Expand Up @@ -399,9 +369,18 @@ export function execute(command: cli.ICommand): Promise<void> {
case cli.CommandType.deploymentHistory:
return deploymentHistory(<cli.IDeploymentHistoryCommand>command);

case cli.CommandType.login:
return login(<cli.ILoginCommand>command);

case cli.CommandType.logout:
return logout(<cli.ILogoutCommand>command);

case cli.CommandType.promote:
return promote(<cli.IPromoteCommand>command);

case cli.CommandType.register:
return register(<cli.IRegisterCommand>command);

case cli.CommandType.release:
return release(<cli.IReleaseCommand>command);

Expand All @@ -410,7 +389,7 @@ export function execute(command: cli.ICommand): Promise<void> {

default:
// We should never see this message as invalid commands should be caught by the argument parser.
log("Invalid command: " + JSON.stringify(command));
throw new Error("Invalid command: " + JSON.stringify(command));
}
});
}
Expand Down Expand Up @@ -511,11 +490,14 @@ function initiateExternalAuthenticationAsync(serverUrl: string, action: string):
function login(command: cli.ILoginCommand): Promise<void> {
// Check if one of the flags were provided.
if (command.accessKey) {
sdk = new AccountManager(command.serverUrl, userAgent);
return sdk.loginWithAccessToken(command.accessKey)
.then((): void => {
// The access token is valid.
serializeConnectionInfo(command.serverUrl, command.accessKey);
sdk = new AccountManager(command.accessKey, userAgent, command.serverUrl);
return sdk.isAuthenticated()
.then((isAuthenticated: boolean): void => {
if (isAuthenticated) {
serializeConnectionInfo(command.serverUrl, command.accessKey);
} else {
throw new Error("Invalid access key.");
}
});
} else {
initiateExternalAuthenticationAsync(command.serverUrl, "login");
Expand All @@ -532,52 +514,51 @@ function loginWithAccessTokenInternal(serverUrl: string): Promise<void> {
return;
}

if (!accessToken) {
var decoded: string = tryBase64Decode(accessToken);
var connectionInfo: ILegacyLoginConnectionInfo|ILoginConnectionInfo = tryJSON(decoded);
if (!connectionInfo) {
throw new Error("Invalid access token.");
}

sdk = new AccountManager(serverUrl, userAgent);
var accessKey: string = getAccessKeyFromConnectionInfo(connectionInfo);
sdk = new AccountManager(accessKey, userAgent, serverUrl);

return sdk.loginWithAccessToken(accessToken)
.then((): void => {
// The access token is valid.
serializeConnectionInfo(serverUrl, accessToken);
return sdk.isAuthenticated()
.then((isAuthenticated: boolean): void => {
if (isAuthenticated) {
serializeConnectionInfo(serverUrl, accessToken);
} else {
throw new Error("Invalid access token.");
}
});
});
}

function logout(command: cli.ILogoutCommand): Promise<void> {
if (connectionInfo) {
var setupPromise: Promise<void> = loginWithAccessToken();
if (!command.isLocal) {
var accessKeyName: string;
setupPromise = setupPromise
.then((): Promise<string> => {
var standardLoginConnectionInfo: IStandardLoginConnectionInfo = <IStandardLoginConnectionInfo>connectionInfo;
var accessKeyLoginConnectionInfo: IAccessKeyLoginConnectionInfo = <IAccessKeyLoginConnectionInfo>connectionInfo;

if (standardLoginConnectionInfo.accessKeyName) {
accessKeyName = standardLoginConnectionInfo.accessKeyName;
return getAccessKeyId(standardLoginConnectionInfo.accessKeyName);
} else {
accessKeyName = accessKeyLoginConnectionInfo.accessKey;
return getAccessKeyId(accessKeyLoginConnectionInfo.accessKey);
}
})
.then((accessKeyId: string): Promise<void> => {
return sdk.removeAccessKey(accessKeyId);
})
.then((): void => {
log("Removed access key " + accessKeyName + ".");
});
}
function getAccessKeyFromConnectionInfo(connectionInfo: ILegacyLoginConnectionInfo|ILoginConnectionInfo): string {
if (!connectionInfo) return null;

return setupPromise
.then((): Promise<void> => sdk.logout(), (): Promise<void> => sdk.logout())
.then((): void => deleteConnectionInfoCache(), (): void => deleteConnectionInfoCache());
var legacyLoginConnectionInfo: ILegacyLoginConnectionInfo = <ILegacyLoginConnectionInfo>connectionInfo;
var loginConnectionInfo: ILoginConnectionInfo = <ILoginConnectionInfo>connectionInfo;

if (legacyLoginConnectionInfo.accessKeyName) {
return legacyLoginConnectionInfo.accessKeyName;
} else {
return loginConnectionInfo.accessKey;
}
}

return Q.fcall(() => { throw new Error("You are not logged in."); });
function logout(command: cli.ILogoutCommand): Promise<void> {
return Q(<void>null)
.then((): Promise<void> => {
if (!command.isLocal) {
return sdk.removeAccessKey(sdk.accessKey)
.then((): void => {
log("Removed access key " + sdk.accessKey + ".");
sdk = null;
});
}
})
.then((): void => deleteConnectionInfoCache(), (): void => deleteConnectionInfoCache());
}

function formatDate(unixOffset: number): string {
Expand Down Expand Up @@ -803,7 +784,7 @@ function release(command: cli.IReleaseCommand): Promise<void> {
}

var lastTotalProgress = 0;
var progressBar = new progress("Upload progress:[:bar] :percent :etas", {
var progressBar = new progress("Upload progress:[:bar] :percent :etas", {
complete: "=",
incomplete: " ",
width: 50,
Expand Down Expand Up @@ -879,23 +860,22 @@ function requestAccessToken(): Promise<string> {
});
}

function serializeConnectionInfo(serverUrl: string, accessToken: string): void {
function serializeConnectionInfo(serverUrl: string, accessTokenOrKey: string): void {
// The access token should have been validated already (i.e.: logging in).
var json: string = tryBase64Decode(accessToken);
var standardLoginConnectionInfo: IStandardLoginConnectionInfo = tryJSON(json);

if (standardLoginConnectionInfo) {
// This is a normal login.
standardLoginConnectionInfo.serverUrl = serverUrl;
json = JSON.stringify(standardLoginConnectionInfo);
fs.writeFileSync(configFilePath, json, { encoding: "utf8" });
var json: string = tryBase64Decode(accessTokenOrKey);
var connectionInfo: ILegacyLoginConnectionInfo|ILoginConnectionInfo = tryJSON(json);

if (connectionInfo) {
// This is a legacy login format
connectionInfo.serverUrl = serverUrl;
} else {
// This login uses an access token
var accessKeyLoginConnectionInfo: IAccessKeyLoginConnectionInfo = { serverUrl: serverUrl, accessKey: accessToken };
json = JSON.stringify(accessKeyLoginConnectionInfo);
fs.writeFileSync(configFilePath, json, { encoding: "utf8" });
// This login uses an access key
connectionInfo = <ILoginConnectionInfo>{ serverUrl: serverUrl, accessKey: accessTokenOrKey };
}

json = JSON.stringify(connectionInfo);
fs.writeFileSync(configFilePath, json, { encoding: "utf8" });

log("\r\nSuccessfully logged-in. Your session token was written to " + chalk.cyan(configFilePath) + ". You can run the " + chalk.cyan("code-push logout") + " command at any time to delete this file and terminate your session.\r\n");
}

Expand All @@ -911,7 +891,6 @@ function throwForMissingCredentials(accessKeyName: string, providerName: string,
if (!accessKeyName) throw new Error("Access key is missing.");
if (!providerName) throw new Error("Provider name is missing.");
if (!providerUniqueId) throw new Error("Provider unique ID is missing.");

}

function throwForInvalidAccessKeyId(accessKeyId: string, accessKeyName: string): void {
Expand Down
2 changes: 1 addition & 1 deletion cli/script/command-parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ function createCommand(): cli.ICommand {
if (arg2) {
cmd = { type: cli.CommandType.accessKeyRemove };

(<cli.IAccessKeyRemoveCommand>cmd).accessKeyName = arg2;
(<cli.IAccessKeyRemoveCommand>cmd).accessKey = arg2;
}
break;
}
Expand Down
5 changes: 2 additions & 3 deletions cli/test/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@ describe("CLI", () => {

sandbox.stub(cmdexec, "confirm", (): Promise<boolean> => Q(wasConfirmed));
log = sandbox.stub(cmdexec, "log", (message: string): void => { });
sandbox.stub(cmdexec, "loginWithAccessToken", (): Promise<void> => Q(<void>null));

cmdexec.sdk = <any>new SdkStub();
});
Expand Down Expand Up @@ -203,7 +202,7 @@ describe("CLI", () => {
it("accessKeyRemove removes access key", (done: MochaDone): void => {
var command: cli.IAccessKeyRemoveCommand = {
type: cli.CommandType.accessKeyRemove,
accessKeyName: "8"
accessKey: "8"
};

var removeAccessKey: Sinon.SinonSpy = sandbox.spy(cmdexec.sdk, "removeAccessKey");
Expand All @@ -222,7 +221,7 @@ describe("CLI", () => {
it("accessKeyRemove does not remove access key if cancelled", (done: MochaDone): void => {
var command: cli.IAccessKeyRemoveCommand = {
type: cli.CommandType.accessKeyRemove,
accessKeyName: "8"
accessKey: "8"
};

var removeAccessKey: Sinon.SinonSpy = sandbox.spy(cmdexec.sdk, "removeAccessKey");
Expand Down
Loading