10000 Added support for git_cred_ssh_key_memory_new GTCredentials by slavikus · Pull Request #507 · libgit2/objective-git · GitHub
[go: up one dir, main page]

Skip to content

Added support for git_cred_ssh_key_memory_new GTCredentials #507

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.

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

Merged
merged 3 commits into from
Aug 13, 2015
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
Added support for git_cred_ssh_key_memory_new GTCredentials
Added +[GTCredential credentialWithUserName:publicKeyString:privateKeyString:passphrase:error:] to support libgit2 git_cred_ssh_key_memory_new() credentials.
  • Loading branch information
slavikus committed Aug 4, 2015
commit 83a9952c53d363769b12d54e1312a72ecd8382e7
12 changes: 12 additions & 0 deletions ObjectiveGit/GTCredential.h
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,18 @@ NS_ASSUME_NONNULL_BEGIN
/// Return a new GTCredential instance, or nil if an error occurred
+ (nullable instancetype)credentialWithUserName:(NSString *)userName publicKeyURL:(nullable NSURL *)publicKeyURL privateKeyURL:(NSURL *)privateKeyURL passphrase:(nullable NSString *)passphrase error:(NSError **)error;

/// Create a credential object from a SSH keyfile data string
///
/// userName - The username to authenticate as. Must not be nil.
Copy link
Member

Choose a reason for hiding this comment

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

Happily I think we can stop writing nilability in the comments, since nullable indicates it!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree; but I tried to follow whatever was in the similar function above :)

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, that's always the best route to take! But happily standards change.

/// publicKeyString - The string containing the public key for that user.
/// Can be omitted to reconstruct the public key from the private key.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: this needs a smidge more indentation.

/// privateKeyString - The URL to the private key for that user. Must not be nil.
/// passphrase - The passPhrase for the private key. Optional if the private key has no password.
/// error - If not NULL, set to any errors that occur.
///
/// Return a new GTCredential instance, or nil if an error occurred
+ (nullable instancetype)credentialWithUserName:(NSString *)userName publicKeyString:(nullable NSString *)publicKeyString privateKeyString:(NSString *)privateKeyString passphrase:(nullable NSString *)passphrase error:(NSError **)error;

/// The underlying `git_cred` object.
- (git_cred *)git_cred __attribute__((objc_returns_inner_pointer));

Expand Down
13 changes: 13 additions & 0 deletions ObjectiveGit/GTCredential.m
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,19 @@ + (instancetype)credentialWithUserName:(NSString *)userName publicKeyURL:(NSURL
return [[self alloc] initWithGitCred:cred];
}

+ (instancetype)credentialWithUserName:(NSString *)userName publicKeyString:(NSString *)publicKeyString privateKeyString:(NSString *)privateKeyString passphrase:(NSString *)passphrase error:(NSError **)error {
NSParameterAssert(privateKeyString != nil);

git_cred *cred;
int gitError = git_cred_ssh_key_memory_new(&cred, userName.UTF8String, publicKeyString.UTF8String, privateKeyString.UTF8String, passphrase.UTF8String);
if (gitError != GIT_OK) {
if (error) *error = [NSError git_errorFor:gitError description:@"Failed to create credentials object" failureReason:@"There was an error creating a credential object for username %@ with the provided public/private key pair.\nPublic key: %@\nPrivate key: %@", userName, publicKeyString, privateKeyString];
return nil;
}

return [[self alloc] initWithGitCred:cred];
}

- (instancetype)initWithGitCred:(git_cred *)cred {
NSParameterAssert(cred != nil);
self = [self init];
Expand Down
0