5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2005 - 2007 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
21 #include "silcconnauth.h"
23 /************************** Types and definitions ***************************/
25 static SilcBool silc_connauth_packet_receive(SilcPacketEngine engine,
26 SilcPacketStream stream,
28 void *callback_context,
31 /* Connection authentication context */
32 struct SilcConnAuthStruct {
35 SilcAsyncOperationStruct op;
36 SilcConnectionType conn_type;
37 SilcAuthMethod auth_method;
39 SilcUInt32 auth_data_len;
40 SilcConnAuthCompletion completion;
41 SilcConnAuthGetAuthData get_auth_data;
43 SilcDList public_keys;
44 SilcSKRStatus skr_status;
45 SilcUInt32 timeout_secs;
47 unsigned int aborted : 1;
48 unsigned int success : 1;
51 /* Packet stream callbacks */
52 static SilcPacketCallbacks silc_connauth_stream_cbs =
54 silc_connauth_packet_receive, NULL, NULL
58 /************************ Static utility functions **************************/
62 static SilcBool silc_connauth_packet_receive(SilcPacketEngine engine,
63 SilcPacketStream stream,
65 void *callback_context,
68 SilcConnAuth connauth = callback_context;
69 connauth->packet = packet;
70 silc_fsm_continue(connauth->fsm);
74 /* Async operation abortion callback */
76 static void silc_connauth_abort(SilcAsyncOperation op, void *context)
78 SilcConnAuth connauth = context;
79 connauth->aborted = TRUE;
82 /* Generates signature for public key based authentication */
84 static SilcBool silc_connauth_get_signature(SilcConnAuth connauth,
85 unsigned char **auth_data,
86 SilcUInt32 *auth_data_len)
90 SilcPrivateKey private_key;
93 SILC_LOG_DEBUG(("Compute signature"));
96 private_key = connauth->auth_data;
98 /* Make the authentication data. Protocol says it is HASH plus
100 len = ske->hash_len + silc_buffer_len(ske->start_payload_copy);
101 auth = silc_buffer_alloc_size(len);
104 silc_buffer_format(auth,
105 SILC_STR_UI_XNSTRING(ske->hash, ske->hash_len),
106 SILC_STR_UI_XNSTRING(
107 ske->start_payload_copy->data,
108 silc_buffer_len(ske->start_payload_copy)),
111 len = ((silc_pkcs_private_key_get_len(private_key) + 7) / 8) + 1;
112 *auth_data = silc_calloc(len, sizeof(**auth_data));
113 if (*auth_data == NULL) {
114 silc_buffer_free(auth);
118 /* Compute signature */
119 if (!silc_pkcs_sign(private_key, auth->data, silc_buffer_len(auth),
120 *auth_data, len, auth_data_len, TRUE, ske->prop->hash)) {
121 silc_free(*auth_data);
122 silc_buffer_free(auth);
126 silc_buffer_free(auth);
130 /* Verifies digital signature */
132 static SilcBool silc_connauth_verify_signature(SilcConnAuth connauth,
133 SilcPublicKey pub_key,
139 SilcSKE ske = connauth->ske;
141 if (!pub_key || !sign)
144 /* Make the authentication data. Protocol says it is HASH plus
146 len = ske->hash_len + silc_buffer_len(ske->start_payload_copy);
147 auth = silc_buffer_alloc_size(len);
150 silc_buffer_format(auth,
151 SILC_STR_UI_XNSTRING(ske->hash, ske->hash_len),
152 SILC_STR_UI_XNSTRING(
153 ske->start_payload_copy->data,
154 silc_buffer_len(ske->start_payload_copy)),
157 /* Verify signature */
158 if (!silc_pkcs_verify(pub_key, sign, sign_len, auth->data,
159 silc_buffer_len(auth), ske->prop->hash)) {
160 silc_buffer_free(auth);
164 silc_buffer_free(auth);
171 SILC_TASK_CALLBACK(silc_connauth_timeout)
173 SilcConnAuth connauth = context;
174 SILC_LOG_DEBUG(("Protocol timeout"));
175 connauth->aborted = TRUE;
176 silc_fsm_continue_sync(connauth->fsm);
181 static void silc_connauth_skr_callback(SilcSKR skr, SilcSKRFind find,
182 SilcSKRStatus status,
183 SilcDList results, void *context)
185 SilcConnAuth connauth = context;
187 silc_skr_find_free(find);
189 connauth->public_keys = results;
190 connauth->skr_status = status;
192 SILC_FSM_CALL_CONTINUE(connauth->fsm);
197 static void silc_connauth_fsm_destructor(SilcFSM fsm, void *fsm_context,
198 void *destructor_context)
204 /******************************* Protocol API *******************************/
206 /* Allocate connection authentication context */
208 SilcConnAuth silc_connauth_alloc(SilcSchedule schedule,
210 SilcUInt32 timeout_secs)
212 SilcConnAuth connauth;
214 if (!schedule || !ske)
217 connauth = silc_calloc(1, sizeof(*connauth));
221 connauth->fsm = silc_fsm_alloc(connauth, silc_connauth_fsm_destructor,
223 if (!connauth->fsm) {
224 silc_connauth_free(connauth);
228 connauth->timeout_secs = timeout_secs;
234 /* Free connection authentication context */
236 void silc_connauth_free(SilcConnAuth connauth)
238 if (connauth->public_keys)
239 silc_dlist_uninit(connauth->public_keys);
243 /* Return associated SKE context */
245 SilcSKE silc_connauth_get_ske(SilcConnAuth connauth)
247 return connauth->ske;
251 /******************************** Initiator *********************************/
253 SILC_FSM_STATE(silc_connauth_st_initiator_start);
254 SILC_FSM_STATE(silc_connauth_st_initiator_result);
255 SILC_FSM_STATE(silc_connauth_st_initiator_failure);
257 SILC_FSM_STATE(silc_connauth_st_initiator_start)
259 SilcConnAuth connauth = fsm_context;
262 unsigned char *auth_data = NULL;
263 SilcUInt32 auth_data_len = 0;
264 SilcPacketFlags flags = 0;
266 SILC_LOG_DEBUG(("Start"));
268 if (connauth->aborted) {
270 silc_fsm_next(fsm, silc_connauth_st_initiator_failure);
271 return SILC_FSM_CONTINUE;
275 if (connauth->timeout_secs)
276 silc_schedule_task_add_timeout(silc_fsm_get_schedule(fsm),
277 silc_connauth_timeout, connauth,
278 connauth->timeout_secs, 0);
280 switch (connauth->auth_method) {
282 /* No authentication required */
285 case SILC_AUTH_PASSWORD:
286 auth_data = silc_memdup(connauth->auth_data, connauth->auth_data_len);
289 silc_fsm_next(fsm, silc_connauth_st_initiator_failure);
290 return SILC_FSM_CONTINUE;
292 auth_data_len = connauth->auth_data_len;
293 flags = SILC_PACKET_FLAG_LONG_PAD;
296 case SILC_AUTH_PUBLIC_KEY:
297 if (!silc_connauth_get_signature(connauth, &auth_data, &auth_data_len)) {
298 /** Error computing signature */
299 silc_fsm_next(fsm, silc_connauth_st_initiator_failure);
300 return SILC_FSM_CONTINUE;
305 payload_len = 4 + auth_data_len;
306 packet = silc_buffer_alloc_size(payload_len);
309 silc_fsm_next(fsm, silc_connauth_st_initiator_failure);
310 return SILC_FSM_CONTINUE;
313 silc_buffer_format(packet,
314 SILC_STR_UI_SHORT(payload_len),
315 SILC_STR_UI_SHORT(connauth->conn_type),
316 SILC_STR_UI_XNSTRING(auth_data, auth_data_len),
319 /* Send the packet */
320 if (!silc_packet_send(connauth->ske->stream, SILC_PACKET_CONNECTION_AUTH,
321 flags, packet->data, silc_buffer_len(packet))) {
322 /** Error sending packet */
323 silc_fsm_next(fsm, silc_connauth_st_initiator_failure);
324 return SILC_FSM_CONTINUE;
328 memset(auth_data, 0, auth_data_len);
329 silc_free(auth_data);
331 silc_buffer_free(packet);
333 /** Wait for responder */
334 silc_fsm_next(fsm, silc_connauth_st_initiator_result);
335 return SILC_FSM_WAIT;
338 SILC_FSM_STATE(silc_connauth_st_initiator_result)
340 SilcConnAuth connauth = fsm_context;
342 SILC_LOG_DEBUG(("Start"));
344 if (connauth->aborted) {
346 silc_fsm_next(fsm, silc_connauth_st_initiator_failure);
347 return SILC_FSM_CONTINUE;
350 /* Check the status of authentication */
351 if (connauth->packet->type == SILC_PACKET_SUCCESS) {
352 SILC_LOG_DEBUG(("Authentication successful"));
353 connauth->success = TRUE;
355 SILC_LOG_DEBUG(("Authentication failed"));
356 connauth->success = FALSE;
358 silc_packet_free(connauth->packet);
360 silc_packet_stream_unlink(connauth->ske->stream,
361 &silc_connauth_stream_cbs, connauth);
362 silc_schedule_task_del_by_context(silc_fsm_get_schedule(fsm), connauth);
364 /* Call completion callback */
365 connauth->completion(connauth, connauth->success, connauth->context);
367 return SILC_FSM_FINISH;
370 SILC_FSM_STATE(silc_connauth_st_initiator_failure)
372 SilcConnAuth connauth = fsm_context;
373 unsigned char error[4];
375 SILC_LOG_DEBUG(("Start"));
377 /* Send FAILURE packet */
378 SILC_PUT32_MSB(SILC_AUTH_FAILED, error);
379 silc_packet_send(connauth->ske->stream, SILC_PACKET_FAILURE, 0, error, 4);
381 /* Call completion callback */
382 connauth->completion(connauth, FALSE, connauth->context);
384 silc_packet_stream_unlink(connauth->ske->stream,
385 &silc_connauth_stream_cbs, connauth);
386 silc_schedule_task_del_by_context(silc_fsm_get_schedule(fsm), connauth);
388 return SILC_FSM_FINISH;
392 silc_connauth_initiator(SilcConnAuth connauth,
393 SilcConnectionType conn_type,
394 SilcAuthMethod auth_method, void *auth_data,
395 SilcUInt32 auth_data_len,
396 SilcConnAuthCompletion completion,
399 SILC_LOG_DEBUG(("Connection authentication as initiator"));
401 if (auth_method == SILC_AUTH_PASSWORD && !auth_data) {
402 completion(connauth, FALSE, context);
406 if (auth_method == SILC_AUTH_PUBLIC_KEY && !auth_data) {
407 completion(connauth, FALSE, context);
411 connauth->conn_type = conn_type;
412 connauth->auth_method = auth_method;
413 connauth->auth_data = auth_data;
414 connauth->auth_data_len = auth_data_len;
415 connauth->completion = completion;
416 connauth->context = context;
418 /* Link to packet stream to get packets */
419 silc_packet_stream_link(connauth->ske->stream,
420 &silc_connauth_stream_cbs, connauth, 1000000,
422 SILC_PACKET_FAILURE, -1);
424 /* Start the protocol */
425 silc_async_init(&connauth->op, silc_connauth_abort, NULL, connauth);
426 silc_fsm_start(connauth->fsm, silc_connauth_st_initiator_start);
428 return &connauth->op;
432 /******************************** Responder *********************************/
434 SILC_FSM_STATE(silc_connauth_st_responder_start);
435 SILC_FSM_STATE(silc_connauth_st_responder_authenticate);
436 SILC_FSM_STATE(silc_connauth_st_responder_authenticate_pk);
437 SILC_FSM_STATE(silc_connauth_st_responder_success);
438 SILC_FSM_STATE(silc_connauth_st_responder_failure);
440 SILC_FSM_STATE(silc_connauth_st_responder_start)
442 SilcConnAuth connauth = fsm_context;
444 SILC_LOG_DEBUG(("Start"));
446 if (connauth->aborted) {
448 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
449 return SILC_FSM_CONTINUE;
453 if (connauth->timeout_secs)
454 silc_schedule_task_add_timeout(silc_fsm_get_schedule(fsm),
455 silc_connauth_timeout, connauth,
456 connauth->timeout_secs, 0);
458 /** Wait for initiator */
459 silc_fsm_next(fsm, silc_connauth_st_responder_authenticate);
460 return SILC_FSM_WAIT;
463 SILC_FSM_STATE(silc_connauth_st_responder_authenticate)
465 SilcConnAuth connauth = fsm_context;
466 SilcUInt16 payload_len;
467 SilcUInt16 conn_type;
468 unsigned char *auth_data = NULL, *passphrase = NULL;
469 SilcUInt32 passphrase_len;
470 SilcSKR repository = NULL;
473 SILC_LOG_DEBUG(("Start"));
475 if (connauth->aborted) {
477 silc_packet_free(connauth->packet);
478 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
479 return SILC_FSM_CONTINUE;
482 if (connauth->packet->type != SILC_PACKET_CONNECTION_AUTH) {
483 /** Protocol failure */
484 silc_packet_free(connauth->packet);
485 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
486 return SILC_FSM_CONTINUE;
489 /* Parse the received authentication data packet. The received
490 payload is Connection Auth Payload. */
491 ret = silc_buffer_unformat(&connauth->packet->buffer,
492 SILC_STR_UI_SHORT(&payload_len),
493 SILC_STR_UI_SHORT(&conn_type),
497 SILC_LOG_ERROR(("Bad payload in authentication packet"));
498 silc_packet_free(connauth->packet);
499 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
500 return SILC_FSM_CONTINUE;
503 if (payload_len != silc_buffer_len(&connauth->packet->buffer)) {
504 /** Bad payload length */
505 SILC_LOG_ERROR(("Bad payload length in authentication packet"));
506 silc_packet_free(connauth->packet);
507 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
508 return SILC_FSM_CONTINUE;
513 if (conn_type < SILC_CONN_CLIENT || conn_type > SILC_CONN_ROUTER) {
514 /** Bad connection type */
515 SILC_LOG_ERROR(("Bad connection type (%d) in authentication packet",
517 silc_packet_free(connauth->packet);
518 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
519 return SILC_FSM_CONTINUE;
522 if (payload_len > 0) {
523 /* Get authentication data */
524 ret = silc_buffer_unformat(&connauth->packet->buffer,
526 SILC_STR_UI_XNSTRING(&auth_data,
531 SILC_LOG_DEBUG(("Bad payload in authentication payload"));
532 silc_packet_free(connauth->packet);
533 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
534 return SILC_FSM_CONTINUE;
537 silc_packet_free(connauth->packet);
539 SILC_LOG_DEBUG(("Remote connection type %d", conn_type));
541 /* Get authentication data */
542 if (!connauth->get_auth_data(connauth, conn_type, &passphrase,
543 &passphrase_len, &repository,
544 connauth->context)) {
545 /** Connection not configured */
546 SILC_LOG_ERROR(("Remote connection not configured"));
547 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
548 return SILC_FSM_CONTINUE;
553 /* Passphrase authentication */
554 if (passphrase && passphrase_len) {
555 SILC_LOG_DEBUG(("Passphrase authentication"));
556 if (!memcmp(auth_data, passphrase, passphrase_len)) {
557 /** Authentication failed */
558 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
559 return SILC_FSM_CONTINUE;
561 } else if (repository) {
562 /* Digital signature */
565 SILC_LOG_DEBUG(("Digital signature authentication"));
567 connauth->auth_data = silc_memdup(auth_data, payload_len);
568 connauth->auth_data_len = payload_len;
570 /* Allocate search constraints for finding the key */
571 find = silc_skr_find_alloc();
573 if (!find || !connauth->auth_data) {
575 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
576 return SILC_FSM_CONTINUE;
579 silc_skr_find_set_pkcs_type(find, connauth->ske->pk_type);
580 silc_skr_find_set_public_key(find, connauth->ske->public_key);
581 silc_skr_find_set_usage(find, (SILC_SKR_USAGE_AUTH |
582 SILC_SKR_USAGE_KEY_AGREEMENT));
584 /** Find public key */
585 silc_fsm_next(fsm, silc_connauth_st_responder_authenticate_pk);
586 SILC_FSM_CALL(silc_skr_find(repository, find, silc_connauth_skr_callback,
591 /* Passphrase auth Ok, or no authentication required */
593 /** Authentication successful */
594 silc_fsm_next(fsm, silc_connauth_st_responder_success);
595 return SILC_FSM_CONTINUE;
598 SILC_FSM_STATE(silc_connauth_st_responder_authenticate_pk)
600 SilcConnAuth connauth = fsm_context;
603 if (connauth->aborted) {
605 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
606 return SILC_FSM_CONTINUE;
609 if (connauth->skr_status != SILC_SKR_OK) {
610 /** Public key not found */
611 SILC_LOG_DEBUG(("Public key not found, error %d", connauth->skr_status));
612 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
613 return SILC_FSM_CONTINUE;
616 SILC_LOG_DEBUG(("Found %d public keys",
617 silc_dlist_count(connauth->public_keys)));
619 /* Verify signature */
620 key = silc_dlist_get(connauth->public_keys);
621 if (!silc_connauth_verify_signature(connauth, key->key,
623 connauth->auth_data_len)) {
624 /** Invalid signature */
625 SILC_LOG_DEBUG(("Invalid signature"));
626 silc_free(connauth->auth_data);
627 silc_fsm_next(fsm, silc_connauth_st_responder_failure);
628 return SILC_FSM_CONTINUE;
631 silc_free(connauth->auth_data);
633 /** Authentication successful */
634 silc_fsm_next(fsm, silc_connauth_st_responder_success);
635 return SILC_FSM_CONTINUE;
638 SILC_FSM_STATE(silc_connauth_st_responder_success)
640 SilcConnAuth connauth = fsm_context;
641 unsigned char tmp[4];
643 SILC_LOG_DEBUG(("Authentication successful"));
645 /* Send FAILURE packet */
646 SILC_PUT32_MSB(SILC_AUTH_OK, tmp);
647 silc_packet_send(connauth->ske->stream, SILC_PACKET_SUCCESS, 0, tmp, 4);
649 /* Call completion callback */
650 connauth->completion(connauth, TRUE, connauth->context);
652 silc_packet_stream_unlink(connauth->ske->stream,
653 &silc_connauth_stream_cbs, connauth);
654 silc_schedule_task_del_by_context(silc_fsm_get_schedule(fsm), connauth);
656 return SILC_FSM_FINISH;
659 SILC_FSM_STATE(silc_connauth_st_responder_failure)
661 SilcConnAuth connauth = fsm_context;
662 unsigned char error[4];
664 SILC_LOG_ERROR(("Authentication failed"));
666 /* Send FAILURE packet */
667 SILC_PUT32_MSB(SILC_AUTH_FAILED, error);
668 silc_packet_send(connauth->ske->stream, SILC_PACKET_FAILURE, 0, error, 4);
670 /* Call completion callback */
671 connauth->completion(connauth, FALSE, connauth->context);
673 silc_packet_stream_unlink(connauth->ske->stream,
674 &silc_connauth_stream_cbs, connauth);
675 silc_schedule_task_del_by_context(silc_fsm_get_schedule(fsm), connauth);
677 return SILC_FSM_FINISH;
681 silc_connauth_responder(SilcConnAuth connauth,
682 SilcConnAuthGetAuthData get_auth_data,
683 SilcConnAuthCompletion completion,
686 SILC_LOG_DEBUG(("Connection authentication as responder"));
688 connauth->get_auth_data = get_auth_data;
689 connauth->completion = completion;
690 connauth->context = context;
692 /* Link to packet stream to get packets */
693 silc_packet_stream_link(connauth->ske->stream,
694 &silc_connauth_stream_cbs, connauth, 1000000,
695 SILC_PACKET_CONNECTION_AUTH,
696 SILC_PACKET_FAILURE, -1);
698 /* Start the protocol */
699 silc_async_init(&connauth->op, silc_connauth_abort, NULL, connauth);
700 silc_fsm_start(connauth->fsm, silc_connauth_st_responder_start);
702 return &connauth->op;