2 * Copyright (C) 2011 John Szakmeister <john@szakmeister.net>
3 * 2012 Philipp A. Hartmann <pah@qo.cx>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * - GNOME Keyring API handling originally written by John Szakmeister
23 * - ported to credential helper API by Philipp A. Hartmann
31 #include <gnome-keyring.h>
34 * This credential struct and API is simplified from git's credential.{h,c}
46 #define CREDENTIAL_INIT \
47 { NULL,NULL,0,NULL,NULL,NULL }
49 typedef int (*credential_op_cb
)(struct credential
*);
51 struct credential_operation
57 #define CREDENTIAL_OP_END \
60 /* ---------------- common helper functions ----------------- */
62 static inline void free_password(char *password
)
68 while (*c
) *c
++ = '\0';
72 static inline void warning(const char *fmt
, ...)
77 fprintf(stderr
, "warning: ");
78 vfprintf(stderr
, fmt
, ap
);
79 fprintf(stderr
, "\n" );
83 static inline void error(const char *fmt
, ...)
88 fprintf(stderr
, "error: ");
89 vfprintf(stderr
, fmt
, ap
);
90 fprintf(stderr
, "\n" );
94 static inline void die_errno(int err
)
96 error("%s", strerror(err
));
100 static inline char *xstrdup(const char *str
)
102 char *ret
= strdup(str
);
109 /* ----------------- GNOME Keyring functions ----------------- */
111 /* create a special keyring option string, if path is given */
112 static char* keyring_object(struct credential
*c
)
119 object
= (char*) malloc(strlen(c
->host
)+strlen(c
->path
)+8);
124 sprintf(object
,"%s:%hd/%s",c
->host
,c
->port
,c
->path
);
126 sprintf(object
,"%s/%s",c
->host
,c
->path
);
131 static int keyring_get(struct credential
*c
)
135 GnomeKeyringNetworkPasswordData
*password_data
;
136 GnomeKeyringResult result
;
138 if (!c
->protocol
|| !(c
->host
|| c
->path
))
141 object
= keyring_object(c
);
143 result
= gnome_keyring_find_network_password_sync(
155 if (result
== GNOME_KEYRING_RESULT_NO_MATCH
)
158 if (result
== GNOME_KEYRING_RESULT_CANCELLED
)
161 if (result
!= GNOME_KEYRING_RESULT_OK
) {
162 error("%s",gnome_keyring_result_to_message(result
));
166 /* pick the first one from the list */
167 password_data
= (GnomeKeyringNetworkPasswordData
*) entries
->data
;
169 free_password(c
->password
);
170 c
->password
= xstrdup(password_data
->password
);
173 c
->username
= xstrdup(password_data
->user
);
175 gnome_keyring_network_password_list_free(entries
);
181 static int keyring_store(struct credential
*c
)
187 * Sanity check that what we are storing is actually sensible.
188 * In particular, we can't make a URL without a protocol field.
189 * Without either a host or pathname (depending on the scheme),
190 * we have no primary key. And without a username and password,
191 * we are not actually storing a credential.
193 if (!c
->protocol
|| !(c
->host
|| c
->path
) ||
194 !c
->username
|| !c
->password
)
197 object
= keyring_object(c
);
199 gnome_keyring_set_network_password_sync(
200 GNOME_KEYRING_DEFAULT
,
215 static int keyring_erase(struct credential
*c
)
219 GnomeKeyringNetworkPasswordData
*password_data
;
220 GnomeKeyringResult result
;
223 * Sanity check that we actually have something to match
224 * against. The input we get is a restrictive pattern,
225 * so technically a blank credential means "erase everything".
226 * But it is too easy to accidentally send this, since it is equivalent
227 * to empty input. So explicitly disallow it, and require that the
228 * pattern have some actual content to match.
230 if (!c
->protocol
&& !c
->host
&& !c
->path
&& !c
->username
)
233 object
= keyring_object(c
);
235 result
= gnome_keyring_find_network_password_sync(
247 if (result
== GNOME_KEYRING_RESULT_NO_MATCH
)
250 if (result
== GNOME_KEYRING_RESULT_CANCELLED
)
253 if (result
!= GNOME_KEYRING_RESULT_OK
)
255 error("%s",gnome_keyring_result_to_message(result
));
259 /* pick the first one from the list (delete all matches?) */
260 password_data
= (GnomeKeyringNetworkPasswordData
*) entries
->data
;
262 result
= gnome_keyring_item_delete_sync(
263 password_data
->keyring
, password_data
->item_id
);
265 gnome_keyring_network_password_list_free(entries
);
267 if (result
!= GNOME_KEYRING_RESULT_OK
)
269 error("%s",gnome_keyring_result_to_message(result
));
277 * Table with helper operation callbacks, used by generic
278 * credential helper main function.
280 static struct credential_operation
const credential_helper_ops
[] =
282 { "get", keyring_get
},
283 { "store", keyring_store
},
284 { "erase", keyring_erase
},
288 /* ------------------ credential functions ------------------ */
290 static void credential_init(struct credential
*c
)
292 memset(c
, 0, sizeof(*c
));
295 static void credential_clear(struct credential
*c
)
301 free_password(c
->password
);
306 static int credential_read(struct credential
*c
)
313 while (fgets(buf
, sizeof(buf
), stdin
))
315 line_len
= strlen(buf
);
317 if (line_len
&& buf
[line_len
-1] == '\n')
318 buf
[--line_len
]='\0';
323 value
= strchr(buf
,'=');
325 warning("invalid credential line: %s", key
);
330 if (!strcmp(key
, "protocol")) {
332 c
->protocol
= xstrdup(value
);
333 } else if (!strcmp(key
, "host")) {
335 c
->host
= xstrdup(value
);
336 value
= strrchr(c
->host
,':');
339 c
->port
= atoi(value
);
341 } else if (!strcmp(key
, "path")) {
343 c
->path
= xstrdup(value
);
344 } else if (!strcmp(key
, "username")) {
346 c
->username
= xstrdup(value
);
347 } else if (!strcmp(key
, "password")) {
348 free_password(c
->password
);
349 c
->password
= xstrdup(value
);
350 while (*value
) *value
++ = '\0';
353 * Ignore other lines; we don't know what they mean, but
354 * this future-proofs us when later versions of git do
355 * learn new lines, and the helpers are updated to match.
361 static void credential_write_item(FILE *fp
, const char *key
, const char *value
)
365 fprintf(fp
, "%s=%s\n", key
, value
);
368 static void credential_write(const struct credential
*c
)
370 /* only write username/password, if set */
371 credential_write_item(stdout
, "username", c
->username
);
372 credential_write_item(stdout
, "password", c
->password
);
375 static void usage(const char *name
)
377 struct credential_operation
const *try_op
= credential_helper_ops
;
378 const char *basename
= strrchr(name
,'/');
380 basename
= (basename
) ? basename
+ 1 : name
;
381 fprintf(stderr
, "usage: %s <", basename
);
382 while (try_op
->name
) {
383 fprintf(stderr
,"%s",(try_op
++)->name
);
385 fprintf(stderr
,"%s","|");
387 fprintf(stderr
,"%s",">\n");
390 int main(int argc
, char *argv
[])
392 int ret
= EXIT_SUCCESS
;
394 struct credential_operation
const *try_op
= credential_helper_ops
;
395 struct credential cred
= CREDENTIAL_INIT
;
402 /* lookup operation callback */
403 while (try_op
->name
&& strcmp(argv
[1], try_op
->name
))
406 /* unsupported operation given -- ignore silently */
407 if (!try_op
->name
|| !try_op
->op
)
410 ret
= credential_read(&cred
);
414 /* perform credential operation */
415 ret
= (*try_op
->op
)(&cred
);
417 credential_write(&cred
);
420 credential_clear(&cred
);